2 * Goramo PCI200SYN synchronous serial card driver for Linux
4 * Copyright (C) 2002-2003 Krzysztof Halasa <khc@pm.waw.pl>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of version 2 of the GNU General Public License
8 * as published by the Free Software Foundation.
10 * For information see <http://www.kernel.org/pub/linux/utils/net/hdlc/>
12 * Sources of information:
13 * Hitachi HD64572 SCA-II User's Manual
14 * PLX Technology Inc. PCI9052 Data Book
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/slab.h>
20 #include <linux/types.h>
21 #include <linux/fcntl.h>
23 #include <linux/string.h>
24 #include <linux/errno.h>
25 #include <linux/init.h>
26 #include <linux/ioport.h>
27 #include <linux/moduleparam.h>
28 #include <linux/netdevice.h>
29 #include <linux/hdlc.h>
30 #include <linux/pci.h>
31 #include <linux/delay.h>
36 static const char* version
= "Goramo PCI200SYN driver version: 1.16";
37 static const char* devname
= "PCI200SYN";
42 #define PCI200SYN_PLX_SIZE 0x80 /* PLX control window size (128b) */
43 #define PCI200SYN_SCA_SIZE 0x400 /* SCA window size (1Kb) */
44 #define ALL_PAGES_ALWAYS_MAPPED
45 #define NEED_DETECT_RAM
46 #define NEED_SCA_MSCI_INTR
47 #define MAX_TX_BUFFERS 10
49 static int pci_clock_freq
= 33000000;
50 #define CLOCK_BASE pci_clock_freq
53 * PLX PCI9052 local configuration and shared runtime registers.
54 * This structure can be used to access 9052 registers (memory mapped).
57 u32 loc_addr_range
[4]; /* 00-0Ch : Local Address Ranges */
58 u32 loc_rom_range
; /* 10h : Local ROM Range */
59 u32 loc_addr_base
[4]; /* 14-20h : Local Address Base Addrs */
60 u32 loc_rom_base
; /* 24h : Local ROM Base */
61 u32 loc_bus_descr
[4]; /* 28-34h : Local Bus Descriptors */
62 u32 rom_bus_descr
; /* 38h : ROM Bus Descriptor */
63 u32 cs_base
[4]; /* 3C-48h : Chip Select Base Addrs */
64 u32 intr_ctrl_stat
; /* 4Ch : Interrupt Control/Status */
65 u32 init_ctrl
; /* 50h : EEPROM ctrl, Init Ctrl, etc */
70 typedef struct port_s
{
71 struct net_device
*dev
;
73 spinlock_t lock
; /* TX lock */
74 sync_serial_settings settings
;
75 int rxpart
; /* partial frame received, next frame invalid*/
76 unsigned short encoding
;
77 unsigned short parity
;
78 u16 rxin
; /* rx ring buffer 'in' pointer */
79 u16 txin
; /* tx ring buffer 'in' and 'last' pointers */
81 u8 rxs
, txs
, tmc
; /* SCA registers */
82 u8 phy_node
; /* physical port # - 0 or 1 */
87 typedef struct card_s
{
88 u8 __iomem
*rambase
; /* buffer memory base (virtual) */
89 u8 __iomem
*scabase
; /* SCA memory base (virtual) */
90 plx9052 __iomem
*plxbase
;/* PLX registers memory base (virtual) */
91 u16 rx_ring_buffers
; /* number of buffers in a ring */
93 u16 buff_offset
; /* offset of first buffer of first channel */
94 u8 irq
; /* interrupt request level */
100 #define sca_in(reg, card) readb(card->scabase + (reg))
101 #define sca_out(value, reg, card) writeb(value, card->scabase + (reg))
102 #define sca_inw(reg, card) readw(card->scabase + (reg))
103 #define sca_outw(value, reg, card) writew(value, card->scabase + (reg))
104 #define sca_inl(reg, card) readl(card->scabase + (reg))
105 #define sca_outl(value, reg, card) writel(value, card->scabase + (reg))
107 #define port_to_card(port) (port->card)
108 #define log_node(port) (port->phy_node)
109 #define phy_node(port) (port->phy_node)
110 #define winbase(card) (card->rambase)
111 #define get_port(card, port) (&card->ports[port])
112 #define sca_flush(card) (sca_in(IER0, card));
114 static inline void new_memcpy_toio(char __iomem
*dest
, char *src
, int length
)
118 len
= length
> 256 ? 256 : length
;
119 memcpy_toio(dest
, src
, len
);
128 #define memcpy_toio new_memcpy_toio
133 static void pci200_set_iface(port_t
*port
)
135 card_t
*card
= port
->card
;
136 u16 msci
= get_msci(port
);
137 u8 rxs
= port
->rxs
& CLK_BRG_MASK
;
138 u8 txs
= port
->txs
& CLK_BRG_MASK
;
140 sca_out(EXS_TES1
, (phy_node(port
) ? MSCI1_OFFSET
: MSCI0_OFFSET
) + EXS
,
142 switch(port
->settings
.clock_type
) {
144 rxs
|= CLK_BRG
; /* BRG output */
145 txs
|= CLK_PIN_OUT
| CLK_TX_RXCLK
; /* RX clock */
149 rxs
|= CLK_LINE
; /* RXC input */
150 txs
|= CLK_PIN_OUT
| CLK_BRG
; /* BRG output */
154 rxs
|= CLK_LINE
; /* RXC input */
155 txs
|= CLK_PIN_OUT
| CLK_TX_RXCLK
; /* RX clock */
158 default: /* EXTernal clock */
159 rxs
|= CLK_LINE
; /* RXC input */
160 txs
|= CLK_PIN_OUT
| CLK_LINE
; /* TXC input */
166 sca_out(rxs
, msci
+ RXS
, card
);
167 sca_out(txs
, msci
+ TXS
, card
);
173 static int pci200_open(struct net_device
*dev
)
175 port_t
*port
= dev_to_port(dev
);
177 int result
= hdlc_open(dev
);
182 pci200_set_iface(port
);
183 sca_flush(port_to_card(port
));
189 static int pci200_close(struct net_device
*dev
)
192 sca_flush(port_to_card(dev_to_port(dev
)));
199 static int pci200_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
)
201 const size_t size
= sizeof(sync_serial_settings
);
202 sync_serial_settings new_line
;
203 sync_serial_settings __user
*line
= ifr
->ifr_settings
.ifs_ifsu
.sync
;
204 port_t
*port
= dev_to_port(dev
);
207 if (cmd
== SIOCDEVPRIVATE
) {
212 if (cmd
!= SIOCWANDEV
)
213 return hdlc_ioctl(dev
, ifr
, cmd
);
215 switch(ifr
->ifr_settings
.type
) {
217 ifr
->ifr_settings
.type
= IF_IFACE_V35
;
218 if (ifr
->ifr_settings
.size
< size
) {
219 ifr
->ifr_settings
.size
= size
; /* data size wanted */
222 if (copy_to_user(line
, &port
->settings
, size
))
227 case IF_IFACE_SYNC_SERIAL
:
228 if (!capable(CAP_NET_ADMIN
))
231 if (copy_from_user(&new_line
, line
, size
))
234 if (new_line
.clock_type
!= CLOCK_EXT
&&
235 new_line
.clock_type
!= CLOCK_TXFROMRX
&&
236 new_line
.clock_type
!= CLOCK_INT
&&
237 new_line
.clock_type
!= CLOCK_TXINT
)
238 return -EINVAL
; /* No such clock setting */
240 if (new_line
.loopback
!= 0 && new_line
.loopback
!= 1)
243 memcpy(&port
->settings
, &new_line
, size
); /* Update settings */
244 pci200_set_iface(port
);
245 sca_flush(port_to_card(port
));
249 return hdlc_ioctl(dev
, ifr
, cmd
);
255 static void pci200_pci_remove_one(struct pci_dev
*pdev
)
258 card_t
*card
= pci_get_drvdata(pdev
);
260 for (i
= 0; i
< 2; i
++)
261 if (card
->ports
[i
].card
) {
262 struct net_device
*dev
= port_to_dev(&card
->ports
[i
]);
263 unregister_hdlc_device(dev
);
267 free_irq(card
->irq
, card
);
270 iounmap(card
->rambase
);
272 iounmap(card
->scabase
);
274 iounmap(card
->plxbase
);
276 pci_release_regions(pdev
);
277 pci_disable_device(pdev
);
278 pci_set_drvdata(pdev
, NULL
);
279 if (card
->ports
[0].dev
)
280 free_netdev(card
->ports
[0].dev
);
281 if (card
->ports
[1].dev
)
282 free_netdev(card
->ports
[1].dev
);
288 static int __devinit
pci200_pci_init_one(struct pci_dev
*pdev
,
289 const struct pci_device_id
*ent
)
295 u32 ramphys
; /* buffer memory base */
296 u32 scaphys
; /* SCA memory base */
297 u32 plxphys
; /* PLX registers memory base */
300 static int printed_version
;
301 if (!printed_version
++)
302 printk(KERN_INFO
"%s\n", version
);
305 i
= pci_enable_device(pdev
);
309 i
= pci_request_regions(pdev
, "PCI200SYN");
311 pci_disable_device(pdev
);
315 card
= kzalloc(sizeof(card_t
), GFP_KERNEL
);
317 printk(KERN_ERR
"pci200syn: unable to allocate memory\n");
318 pci_release_regions(pdev
);
319 pci_disable_device(pdev
);
322 pci_set_drvdata(pdev
, card
);
323 card
->ports
[0].dev
= alloc_hdlcdev(&card
->ports
[0]);
324 card
->ports
[1].dev
= alloc_hdlcdev(&card
->ports
[1]);
325 if (!card
->ports
[0].dev
|| !card
->ports
[1].dev
) {
326 printk(KERN_ERR
"pci200syn: unable to allocate memory\n");
327 pci200_pci_remove_one(pdev
);
331 if (pci_resource_len(pdev
, 0) != PCI200SYN_PLX_SIZE
||
332 pci_resource_len(pdev
, 2) != PCI200SYN_SCA_SIZE
||
333 pci_resource_len(pdev
, 3) < 16384) {
334 printk(KERN_ERR
"pci200syn: invalid card EEPROM parameters\n");
335 pci200_pci_remove_one(pdev
);
339 plxphys
= pci_resource_start(pdev
,0) & PCI_BASE_ADDRESS_MEM_MASK
;
340 card
->plxbase
= ioremap(plxphys
, PCI200SYN_PLX_SIZE
);
342 scaphys
= pci_resource_start(pdev
,2) & PCI_BASE_ADDRESS_MEM_MASK
;
343 card
->scabase
= ioremap(scaphys
, PCI200SYN_SCA_SIZE
);
345 ramphys
= pci_resource_start(pdev
,3) & PCI_BASE_ADDRESS_MEM_MASK
;
346 card
->rambase
= ioremap(ramphys
, pci_resource_len(pdev
,3));
348 if (card
->plxbase
== NULL
||
349 card
->scabase
== NULL
||
350 card
->rambase
== NULL
) {
351 printk(KERN_ERR
"pci200syn: ioremap() failed\n");
352 pci200_pci_remove_one(pdev
);
357 p
= &card
->plxbase
->init_ctrl
;
358 writel(readl(p
) | 0x40000000, p
);
359 readl(p
); /* Flush the write - do not use sca_flush */
362 writel(readl(p
) & ~0x40000000, p
);
363 readl(p
); /* Flush the write - do not use sca_flush */
366 ramsize
= sca_detect_ram(card
, card
->rambase
,
367 pci_resource_len(pdev
, 3));
369 /* number of TX + RX buffers for one port - this is dual port card */
370 i
= ramsize
/ (2 * (sizeof(pkt_desc
) + HDLC_MAX_MRU
));
371 card
->tx_ring_buffers
= min(i
/ 2, MAX_TX_BUFFERS
);
372 card
->rx_ring_buffers
= i
- card
->tx_ring_buffers
;
374 card
->buff_offset
= 2 * sizeof(pkt_desc
) * (card
->tx_ring_buffers
+
375 card
->rx_ring_buffers
);
377 printk(KERN_INFO
"pci200syn: %u KB RAM at 0x%x, IRQ%u, using %u TX +"
378 " %u RX packets rings\n", ramsize
/ 1024, ramphys
,
379 pdev
->irq
, card
->tx_ring_buffers
, card
->rx_ring_buffers
);
381 if (pdev
->subsystem_device
== PCI_DEVICE_ID_PLX_9050
) {
382 printk(KERN_ERR
"Detected PCI200SYN card with old "
383 "configuration data.\n");
384 printk(KERN_ERR
"See <http://www.kernel.org/pub/"
385 "linux/utils/net/hdlc/pci200syn/> for update.\n");
386 printk(KERN_ERR
"The card will stop working with"
387 " future versions of Linux if not updated.\n");
390 if (card
->tx_ring_buffers
< 1) {
391 printk(KERN_ERR
"pci200syn: RAM test failed\n");
392 pci200_pci_remove_one(pdev
);
396 /* Enable interrupts on the PCI bridge */
397 p
= &card
->plxbase
->intr_ctrl_stat
;
398 writew(readw(p
) | 0x0040, p
);
401 if (request_irq(pdev
->irq
, sca_intr
, IRQF_SHARED
, devname
, card
)) {
402 printk(KERN_WARNING
"pci200syn: could not allocate IRQ%d.\n",
404 pci200_pci_remove_one(pdev
);
407 card
->irq
= pdev
->irq
;
411 for (i
= 0; i
< 2; i
++) {
412 port_t
*port
= &card
->ports
[i
];
413 struct net_device
*dev
= port_to_dev(port
);
414 hdlc_device
*hdlc
= dev_to_hdlc(dev
);
417 spin_lock_init(&port
->lock
);
418 dev
->irq
= card
->irq
;
419 dev
->mem_start
= ramphys
;
420 dev
->mem_end
= ramphys
+ ramsize
- 1;
421 dev
->tx_queue_len
= 50;
422 dev
->do_ioctl
= pci200_ioctl
;
423 dev
->open
= pci200_open
;
424 dev
->stop
= pci200_close
;
425 hdlc
->attach
= sca_attach
;
426 hdlc
->xmit
= sca_xmit
;
427 port
->settings
.clock_type
= CLOCK_EXT
;
429 if (register_hdlc_device(dev
)) {
430 printk(KERN_ERR
"pci200syn: unable to register hdlc "
433 pci200_pci_remove_one(pdev
);
436 sca_init_sync_port(port
); /* Set up SCA memory */
438 printk(KERN_INFO
"%s: PCI200SYN node %d\n",
439 dev
->name
, port
->phy_node
);
448 static struct pci_device_id pci200_pci_tbl
[] __devinitdata
= {
449 { PCI_VENDOR_ID_PLX
, PCI_DEVICE_ID_PLX_9050
, PCI_VENDOR_ID_PLX
,
450 PCI_DEVICE_ID_PLX_9050
, 0, 0, 0 },
451 { PCI_VENDOR_ID_PLX
, PCI_DEVICE_ID_PLX_9050
, PCI_VENDOR_ID_PLX
,
452 PCI_DEVICE_ID_PLX_PCI200SYN
, 0, 0, 0 },
457 static struct pci_driver pci200_pci_driver
= {
459 .id_table
= pci200_pci_tbl
,
460 .probe
= pci200_pci_init_one
,
461 .remove
= pci200_pci_remove_one
,
465 static int __init
pci200_init_module(void)
468 printk(KERN_INFO
"%s\n", version
);
470 if (pci_clock_freq
< 1000000 || pci_clock_freq
> 80000000) {
471 printk(KERN_ERR
"pci200syn: Invalid PCI clock frequency\n");
474 return pci_register_driver(&pci200_pci_driver
);
479 static void __exit
pci200_cleanup_module(void)
481 pci_unregister_driver(&pci200_pci_driver
);
484 MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
485 MODULE_DESCRIPTION("Goramo PCI200SYN serial port driver");
486 MODULE_LICENSE("GPL v2");
487 MODULE_DEVICE_TABLE(pci
, pci200_pci_tbl
);
488 module_param(pci_clock_freq
, int, 0444);
489 MODULE_PARM_DESC(pci_clock_freq
, "System PCI clock frequency in Hz");
490 module_init(pci200_init_module
);
491 module_exit(pci200_cleanup_module
);