2 * Cyclades PC300 synchronous serial card driver for Linux
4 * Copyright (C) 2000-2008 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 * Original Cyclades PC300 Linux driver
16 * This driver currently supports only PC300/RSV (V.24/V.35) and
20 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/slab.h>
25 #include <linux/sched.h>
26 #include <linux/types.h>
27 #include <linux/fcntl.h>
29 #include <linux/string.h>
30 #include <linux/errno.h>
31 #include <linux/init.h>
32 #include <linux/ioport.h>
33 #include <linux/moduleparam.h>
34 #include <linux/netdevice.h>
35 #include <linux/hdlc.h>
36 #include <linux/pci.h>
37 #include <linux/delay.h>
45 #define PC300_PLX_SIZE 0x80 /* PLX control window size (128 B) */
46 #define PC300_SCA_SIZE 0x400 /* SCA window size (1 KB) */
47 #define MAX_TX_BUFFERS 10
49 static int pci_clock_freq
= 33000000;
50 static int use_crystal_clock
= 0;
51 static unsigned int CLOCK_BASE
;
53 /* Masks to access the init_ctrl PLX register */
54 #define PC300_CLKSEL_MASK (0x00000004UL)
55 #define PC300_CHMEDIA_MASK(port) (0x00000020UL << ((port) * 3))
56 #define PC300_CTYPE_MASK (0x00000800UL)
59 enum { PC300_RSV
= 1, PC300_X21
, PC300_TE
}; /* card types */
62 * PLX PCI9050-1 local configuration and shared runtime registers.
63 * This structure can be used to access 9050 registers (memory mapped).
66 u32 loc_addr_range
[4]; /* 00-0Ch : Local Address Ranges */
67 u32 loc_rom_range
; /* 10h : Local ROM Range */
68 u32 loc_addr_base
[4]; /* 14-20h : Local Address Base Addrs */
69 u32 loc_rom_base
; /* 24h : Local ROM Base */
70 u32 loc_bus_descr
[4]; /* 28-34h : Local Bus Descriptors */
71 u32 rom_bus_descr
; /* 38h : ROM Bus Descriptor */
72 u32 cs_base
[4]; /* 3C-48h : Chip Select Base Addrs */
73 u32 intr_ctrl_stat
; /* 4Ch : Interrupt Control/Status */
74 u32 init_ctrl
; /* 50h : EEPROM ctrl, Init Ctrl, etc */
79 typedef struct port_s
{
80 struct napi_struct napi
;
81 struct net_device
*netdev
;
83 spinlock_t lock
; /* TX lock */
84 sync_serial_settings settings
;
85 int rxpart
; /* partial frame received, next frame invalid*/
86 unsigned short encoding
;
87 unsigned short parity
;
89 u16 rxin
; /* rx ring buffer 'in' pointer */
90 u16 txin
; /* tx ring buffer 'in' and 'last' pointers */
92 u8 rxs
, txs
, tmc
; /* SCA registers */
93 u8 chan
; /* physical port # - 0 or 1 */
98 typedef struct card_s
{
99 int type
; /* RSV, X21, etc. */
100 int n_ports
; /* 1 or 2 ports */
101 u8 __iomem
*rambase
; /* buffer memory base (virtual) */
102 u8 __iomem
*scabase
; /* SCA memory base (virtual) */
103 plx9050 __iomem
*plxbase
; /* PLX registers memory base (virtual) */
104 u32 init_ctrl_value
; /* Saved value - 9050 bug workaround */
105 u16 rx_ring_buffers
; /* number of buffers in a ring */
107 u16 buff_offset
; /* offset of first buffer of first channel */
108 u8 irq
; /* interrupt request level */
114 #define get_port(card, port) ((port) < (card)->n_ports ? \
115 (&(card)->ports[port]) : (NULL))
120 static void pc300_set_iface(port_t
*port
)
122 card_t
*card
= port
->card
;
123 u32 __iomem
* init_ctrl
= &card
->plxbase
->init_ctrl
;
124 u16 msci
= get_msci(port
);
125 u8 rxs
= port
->rxs
& CLK_BRG_MASK
;
126 u8 txs
= port
->txs
& CLK_BRG_MASK
;
128 sca_out(EXS_TES1
, (port
->chan
? MSCI1_OFFSET
: MSCI0_OFFSET
) + EXS
,
130 switch(port
->settings
.clock_type
) {
132 rxs
|= CLK_BRG
; /* BRG output */
133 txs
|= CLK_PIN_OUT
| CLK_TX_RXCLK
; /* RX clock */
137 rxs
|= CLK_LINE
; /* RXC input */
138 txs
|= CLK_PIN_OUT
| CLK_BRG
; /* BRG output */
142 rxs
|= CLK_LINE
; /* RXC input */
143 txs
|= CLK_PIN_OUT
| CLK_TX_RXCLK
; /* RX clock */
146 default: /* EXTernal clock */
147 rxs
|= CLK_LINE
; /* RXC input */
148 txs
|= CLK_PIN_OUT
| CLK_LINE
; /* TXC input */
154 sca_out(rxs
, msci
+ RXS
, card
);
155 sca_out(txs
, msci
+ TXS
, card
);
158 if (port
->card
->type
== PC300_RSV
) {
159 if (port
->iface
== IF_IFACE_V35
)
160 writel(card
->init_ctrl_value
|
161 PC300_CHMEDIA_MASK(port
->chan
), init_ctrl
);
163 writel(card
->init_ctrl_value
&
164 ~PC300_CHMEDIA_MASK(port
->chan
), init_ctrl
);
170 static int pc300_open(struct net_device
*dev
)
172 port_t
*port
= dev_to_port(dev
);
174 int result
= hdlc_open(dev
);
179 pc300_set_iface(port
);
185 static int pc300_close(struct net_device
*dev
)
194 static int pc300_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
)
196 const size_t size
= sizeof(sync_serial_settings
);
197 sync_serial_settings new_line
;
198 sync_serial_settings __user
*line
= ifr
->ifr_settings
.ifs_ifsu
.sync
;
200 port_t
*port
= dev_to_port(dev
);
203 if (cmd
== SIOCDEVPRIVATE
) {
208 if (cmd
!= SIOCWANDEV
)
209 return hdlc_ioctl(dev
, ifr
, cmd
);
211 if (ifr
->ifr_settings
.type
== IF_GET_IFACE
) {
212 ifr
->ifr_settings
.type
= port
->iface
;
213 if (ifr
->ifr_settings
.size
< size
) {
214 ifr
->ifr_settings
.size
= size
; /* data size wanted */
217 if (copy_to_user(line
, &port
->settings
, size
))
223 if (port
->card
->type
== PC300_X21
&&
224 (ifr
->ifr_settings
.type
== IF_IFACE_SYNC_SERIAL
||
225 ifr
->ifr_settings
.type
== IF_IFACE_X21
))
226 new_type
= IF_IFACE_X21
;
228 else if (port
->card
->type
== PC300_RSV
&&
229 (ifr
->ifr_settings
.type
== IF_IFACE_SYNC_SERIAL
||
230 ifr
->ifr_settings
.type
== IF_IFACE_V35
))
231 new_type
= IF_IFACE_V35
;
233 else if (port
->card
->type
== PC300_RSV
&&
234 ifr
->ifr_settings
.type
== IF_IFACE_V24
)
235 new_type
= IF_IFACE_V24
;
238 return hdlc_ioctl(dev
, ifr
, cmd
);
240 if (!capable(CAP_NET_ADMIN
))
243 if (copy_from_user(&new_line
, line
, size
))
246 if (new_line
.clock_type
!= CLOCK_EXT
&&
247 new_line
.clock_type
!= CLOCK_TXFROMRX
&&
248 new_line
.clock_type
!= CLOCK_INT
&&
249 new_line
.clock_type
!= CLOCK_TXINT
)
250 return -EINVAL
; /* No such clock setting */
252 if (new_line
.loopback
!= 0 && new_line
.loopback
!= 1)
255 memcpy(&port
->settings
, &new_line
, size
); /* Update settings */
256 port
->iface
= new_type
;
257 pc300_set_iface(port
);
263 static void pc300_pci_remove_one(struct pci_dev
*pdev
)
266 card_t
*card
= pci_get_drvdata(pdev
);
268 for (i
= 0; i
< 2; i
++)
269 if (card
->ports
[i
].card
)
270 unregister_hdlc_device(card
->ports
[i
].netdev
);
273 free_irq(card
->irq
, card
);
276 iounmap(card
->rambase
);
278 iounmap(card
->scabase
);
280 iounmap(card
->plxbase
);
282 pci_release_regions(pdev
);
283 pci_disable_device(pdev
);
284 pci_set_drvdata(pdev
, NULL
);
285 if (card
->ports
[0].netdev
)
286 free_netdev(card
->ports
[0].netdev
);
287 if (card
->ports
[1].netdev
)
288 free_netdev(card
->ports
[1].netdev
);
292 static const struct net_device_ops pc300_ops
= {
293 .ndo_open
= pc300_open
,
294 .ndo_stop
= pc300_close
,
295 .ndo_change_mtu
= hdlc_change_mtu
,
296 .ndo_start_xmit
= hdlc_start_xmit
,
297 .ndo_do_ioctl
= pc300_ioctl
,
300 static int __devinit
pc300_pci_init_one(struct pci_dev
*pdev
,
301 const struct pci_device_id
*ent
)
307 u32 ramphys
; /* buffer memory base */
308 u32 scaphys
; /* SCA memory base */
309 u32 plxphys
; /* PLX registers memory base */
311 i
= pci_enable_device(pdev
);
315 i
= pci_request_regions(pdev
, "PC300");
317 pci_disable_device(pdev
);
321 card
= kzalloc(sizeof(card_t
), GFP_KERNEL
);
323 pr_err("unable to allocate memory\n");
324 pci_release_regions(pdev
);
325 pci_disable_device(pdev
);
328 pci_set_drvdata(pdev
, card
);
330 if (pci_resource_len(pdev
, 0) != PC300_PLX_SIZE
||
331 pci_resource_len(pdev
, 2) != PC300_SCA_SIZE
||
332 pci_resource_len(pdev
, 3) < 16384) {
333 pr_err("invalid card EEPROM parameters\n");
334 pc300_pci_remove_one(pdev
);
338 plxphys
= pci_resource_start(pdev
, 0) & PCI_BASE_ADDRESS_MEM_MASK
;
339 card
->plxbase
= ioremap(plxphys
, PC300_PLX_SIZE
);
341 scaphys
= pci_resource_start(pdev
, 2) & PCI_BASE_ADDRESS_MEM_MASK
;
342 card
->scabase
= ioremap(scaphys
, PC300_SCA_SIZE
);
344 ramphys
= pci_resource_start(pdev
, 3) & PCI_BASE_ADDRESS_MEM_MASK
;
345 card
->rambase
= pci_ioremap_bar(pdev
, 3);
347 if (card
->plxbase
== NULL
||
348 card
->scabase
== NULL
||
349 card
->rambase
== NULL
) {
350 pr_err("ioremap() failed\n");
351 pc300_pci_remove_one(pdev
);
354 /* PLX PCI 9050 workaround for local configuration register read bug */
355 pci_write_config_dword(pdev
, PCI_BASE_ADDRESS_0
, scaphys
);
356 card
->init_ctrl_value
= readl(&((plx9050 __iomem
*)card
->scabase
)->init_ctrl
);
357 pci_write_config_dword(pdev
, PCI_BASE_ADDRESS_0
, plxphys
);
359 if (pdev
->device
== PCI_DEVICE_ID_PC300_TE_1
||
360 pdev
->device
== PCI_DEVICE_ID_PC300_TE_2
)
361 card
->type
= PC300_TE
; /* not fully supported */
362 else if (card
->init_ctrl_value
& PC300_CTYPE_MASK
)
363 card
->type
= PC300_X21
;
365 card
->type
= PC300_RSV
;
367 if (pdev
->device
== PCI_DEVICE_ID_PC300_RX_1
||
368 pdev
->device
== PCI_DEVICE_ID_PC300_TE_1
)
373 for (i
= 0; i
< card
->n_ports
; i
++)
374 if (!(card
->ports
[i
].netdev
= alloc_hdlcdev(&card
->ports
[i
]))) {
375 pr_err("unable to allocate memory\n");
376 pc300_pci_remove_one(pdev
);
381 p
= &card
->plxbase
->init_ctrl
;
382 writel(card
->init_ctrl_value
| 0x40000000, p
);
383 readl(p
); /* Flush the write - do not use sca_flush */
386 writel(card
->init_ctrl_value
, p
);
387 readl(p
); /* Flush the write - do not use sca_flush */
390 /* Reload Config. Registers from EEPROM */
391 writel(card
->init_ctrl_value
| 0x20000000, p
);
392 readl(p
); /* Flush the write - do not use sca_flush */
395 writel(card
->init_ctrl_value
, p
);
396 readl(p
); /* Flush the write - do not use sca_flush */
399 ramsize
= sca_detect_ram(card
, card
->rambase
,
400 pci_resource_len(pdev
, 3));
402 if (use_crystal_clock
)
403 card
->init_ctrl_value
&= ~PC300_CLKSEL_MASK
;
405 card
->init_ctrl_value
|= PC300_CLKSEL_MASK
;
407 writel(card
->init_ctrl_value
, &card
->plxbase
->init_ctrl
);
408 /* number of TX + RX buffers for one port */
409 i
= ramsize
/ (card
->n_ports
* (sizeof(pkt_desc
) + HDLC_MAX_MRU
));
410 card
->tx_ring_buffers
= min(i
/ 2, MAX_TX_BUFFERS
);
411 card
->rx_ring_buffers
= i
- card
->tx_ring_buffers
;
413 card
->buff_offset
= card
->n_ports
* sizeof(pkt_desc
) *
414 (card
->tx_ring_buffers
+ card
->rx_ring_buffers
);
416 pr_info("PC300/%s, %u KB RAM at 0x%x, IRQ%u, using %u TX + %u RX packets rings\n",
417 card
->type
== PC300_X21
? "X21" :
418 card
->type
== PC300_TE
? "TE" : "RSV",
419 ramsize
/ 1024, ramphys
, pdev
->irq
,
420 card
->tx_ring_buffers
, card
->rx_ring_buffers
);
422 if (card
->tx_ring_buffers
< 1) {
423 pr_err("RAM test failed\n");
424 pc300_pci_remove_one(pdev
);
428 /* Enable interrupts on the PCI bridge, LINTi1 active low */
429 writew(0x0041, &card
->plxbase
->intr_ctrl_stat
);
432 if (request_irq(pdev
->irq
, sca_intr
, IRQF_SHARED
, "pc300", card
)) {
433 pr_warn("could not allocate IRQ%d\n", pdev
->irq
);
434 pc300_pci_remove_one(pdev
);
437 card
->irq
= pdev
->irq
;
441 // COTE not set - allows better TX DMA settings
442 // sca_out(sca_in(PCR, card) | PCR_COTE, PCR, card);
444 sca_out(0x10, BTCR
, card
);
446 for (i
= 0; i
< card
->n_ports
; i
++) {
447 port_t
*port
= &card
->ports
[i
];
448 struct net_device
*dev
= port
->netdev
;
449 hdlc_device
*hdlc
= dev_to_hdlc(dev
);
452 spin_lock_init(&port
->lock
);
453 dev
->irq
= card
->irq
;
454 dev
->mem_start
= ramphys
;
455 dev
->mem_end
= ramphys
+ ramsize
- 1;
456 dev
->tx_queue_len
= 50;
457 dev
->netdev_ops
= &pc300_ops
;
458 hdlc
->attach
= sca_attach
;
459 hdlc
->xmit
= sca_xmit
;
460 port
->settings
.clock_type
= CLOCK_EXT
;
462 if (card
->type
== PC300_X21
)
463 port
->iface
= IF_IFACE_X21
;
465 port
->iface
= IF_IFACE_V35
;
468 if (register_hdlc_device(dev
)) {
469 pr_err("unable to register hdlc device\n");
471 pc300_pci_remove_one(pdev
);
475 netdev_info(dev
, "PC300 channel %d\n", port
->chan
);
482 static DEFINE_PCI_DEVICE_TABLE(pc300_pci_tbl
) = {
483 { PCI_VENDOR_ID_CYCLADES
, PCI_DEVICE_ID_PC300_RX_1
, PCI_ANY_ID
,
484 PCI_ANY_ID
, 0, 0, 0 },
485 { PCI_VENDOR_ID_CYCLADES
, PCI_DEVICE_ID_PC300_RX_2
, PCI_ANY_ID
,
486 PCI_ANY_ID
, 0, 0, 0 },
487 { PCI_VENDOR_ID_CYCLADES
, PCI_DEVICE_ID_PC300_TE_1
, PCI_ANY_ID
,
488 PCI_ANY_ID
, 0, 0, 0 },
489 { PCI_VENDOR_ID_CYCLADES
, PCI_DEVICE_ID_PC300_TE_2
, PCI_ANY_ID
,
490 PCI_ANY_ID
, 0, 0, 0 },
495 static struct pci_driver pc300_pci_driver
= {
497 .id_table
= pc300_pci_tbl
,
498 .probe
= pc300_pci_init_one
,
499 .remove
= pc300_pci_remove_one
,
503 static int __init
pc300_init_module(void)
505 if (pci_clock_freq
< 1000000 || pci_clock_freq
> 80000000) {
506 pr_err("Invalid PCI clock frequency\n");
509 if (use_crystal_clock
!= 0 && use_crystal_clock
!= 1) {
510 pr_err("Invalid 'use_crystal_clock' value\n");
514 CLOCK_BASE
= use_crystal_clock
? 24576000 : pci_clock_freq
;
516 return pci_register_driver(&pc300_pci_driver
);
521 static void __exit
pc300_cleanup_module(void)
523 pci_unregister_driver(&pc300_pci_driver
);
526 MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
527 MODULE_DESCRIPTION("Cyclades PC300 serial port driver");
528 MODULE_LICENSE("GPL v2");
529 MODULE_DEVICE_TABLE(pci
, pc300_pci_tbl
);
530 module_param(pci_clock_freq
, int, 0444);
531 MODULE_PARM_DESC(pci_clock_freq
, "System PCI clock frequency in Hz");
532 module_param(use_crystal_clock
, int, 0444);
533 MODULE_PARM_DESC(use_crystal_clock
,
534 "Use 24.576 MHz clock instead of PCI clock");
535 module_init(pc300_init_module
);
536 module_exit(pc300_cleanup_module
);