xref: /linux/drivers/net/wan/wanxl.h (revision 3213486f2e442831e324cc6201a2f9e924ecc235)
1 /*
2  * wanXL serial card driver for Linux
3  * definitions common to host driver and card firmware
4  *
5  * Copyright (C) 2003 Krzysztof Halasa <khc@pm.waw.pl>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of version 2 of the GNU General Public License
9  * as published by the Free Software Foundation.
10  */
11 
12 #define RESET_WHILE_LOADING 0
13 
14 /* you must rebuild the firmware if any of the following is changed */
15 #define DETECT_RAM 0		/* needed for > 4MB RAM, 16 MB maximum */
16 #define QUICC_MEMCPY_USES_PLX 1	/* must be used if the host has > 256 MB RAM */
17 
18 
19 #define STATUS_CABLE_V35	2
20 #define STATUS_CABLE_X21	3
21 #define STATUS_CABLE_V24	4
22 #define STATUS_CABLE_EIA530	5
23 #define STATUS_CABLE_INVALID	6
24 #define STATUS_CABLE_NONE	7
25 
26 #define STATUS_CABLE_DCE	0x8000
27 #define STATUS_CABLE_DSR	0x0010
28 #define STATUS_CABLE_DCD	0x0008
29 #define STATUS_CABLE_PM_SHIFT	5
30 
31 #define PDM_OFFSET 0x1000
32 
33 #define TX_BUFFERS 10		/* per port */
34 #define RX_BUFFERS 30
35 #define RX_QUEUE_LENGTH 40	/* card->host queue length - per card */
36 
37 #define PACKET_EMPTY		0x00
38 #define PACKET_FULL		0x10
39 #define PACKET_SENT		0x20 /* TX only */
40 #define PACKET_UNDERRUN		0x30 /* TX only */
41 #define PACKET_PORT_MASK	0x03 /* RX only */
42 
43 /* bit numbers in PLX9060 doorbell registers */
44 #define DOORBELL_FROM_CARD_TX_0		0 /* packet sent by the card */
45 #define DOORBELL_FROM_CARD_TX_1		1
46 #define DOORBELL_FROM_CARD_TX_2		2
47 #define DOORBELL_FROM_CARD_TX_3		3
48 #define DOORBELL_FROM_CARD_RX		4
49 #define DOORBELL_FROM_CARD_CABLE_0	5 /* cable/PM/etc. changed */
50 #define DOORBELL_FROM_CARD_CABLE_1	6
51 #define DOORBELL_FROM_CARD_CABLE_2	7
52 #define DOORBELL_FROM_CARD_CABLE_3	8
53 
54 #define DOORBELL_TO_CARD_OPEN_0		0
55 #define DOORBELL_TO_CARD_OPEN_1		1
56 #define DOORBELL_TO_CARD_OPEN_2		2
57 #define DOORBELL_TO_CARD_OPEN_3		3
58 #define DOORBELL_TO_CARD_CLOSE_0	4
59 #define DOORBELL_TO_CARD_CLOSE_1	5
60 #define DOORBELL_TO_CARD_CLOSE_2	6
61 #define DOORBELL_TO_CARD_CLOSE_3	7
62 #define DOORBELL_TO_CARD_TX_0		8 /* outbound packet queued */
63 #define DOORBELL_TO_CARD_TX_1		9
64 #define DOORBELL_TO_CARD_TX_2		10
65 #define DOORBELL_TO_CARD_TX_3		11
66 
67 /* firmware-only status bits, starting from last DOORBELL_TO_CARD + 1 */
68 #define TASK_SCC_0			12
69 #define TASK_SCC_1			13
70 #define TASK_SCC_2			14
71 #define TASK_SCC_3			15
72 
73 #define ALIGN32(x) (((x) + 3) & 0xFFFFFFFC)
74 #define BUFFER_LENGTH	ALIGN32(HDLC_MAX_MRU + 4) /* 4 bytes for 32-bit CRC */
75 
76 /* Address of TX and RX buffers in 68360 address space */
77 #define BUFFERS_ADDR	0x4000	/* 16 KB */
78 
79 #ifndef __ASSEMBLER__
80 #define PLX_OFFSET		0
81 #else
82 #define PLX_OFFSET		PLX + 0x80
83 #endif
84 
85 #define PLX_MAILBOX_0		(PLX_OFFSET + 0x40)
86 #define PLX_MAILBOX_1		(PLX_OFFSET + 0x44)
87 #define PLX_MAILBOX_2		(PLX_OFFSET + 0x48)
88 #define PLX_MAILBOX_3		(PLX_OFFSET + 0x4C)
89 #define PLX_MAILBOX_4		(PLX_OFFSET + 0x50)
90 #define PLX_MAILBOX_5		(PLX_OFFSET + 0x54)
91 #define PLX_MAILBOX_6		(PLX_OFFSET + 0x58)
92 #define PLX_MAILBOX_7		(PLX_OFFSET + 0x5C)
93 #define PLX_DOORBELL_TO_CARD	(PLX_OFFSET + 0x60)
94 #define PLX_DOORBELL_FROM_CARD	(PLX_OFFSET + 0x64)
95 #define PLX_INTERRUPT_CS	(PLX_OFFSET + 0x68)
96 #define PLX_CONTROL		(PLX_OFFSET + 0x6C)
97 
98 #ifdef __ASSEMBLER__
99 #define PLX_DMA_0_MODE		(PLX + 0x100)
100 #define PLX_DMA_0_PCI		(PLX + 0x104)
101 #define PLX_DMA_0_LOCAL		(PLX + 0x108)
102 #define PLX_DMA_0_LENGTH	(PLX + 0x10C)
103 #define PLX_DMA_0_DESC		(PLX + 0x110)
104 #define PLX_DMA_1_MODE		(PLX + 0x114)
105 #define PLX_DMA_1_PCI		(PLX + 0x118)
106 #define PLX_DMA_1_LOCAL		(PLX + 0x11C)
107 #define PLX_DMA_1_LENGTH	(PLX + 0x120)
108 #define PLX_DMA_1_DESC		(PLX + 0x124)
109 #define PLX_DMA_CMD_STS		(PLX + 0x128)
110 #define PLX_DMA_ARBITR_0	(PLX + 0x12C)
111 #define PLX_DMA_ARBITR_1	(PLX + 0x130)
112 #endif
113 
114 #define DESC_LENGTH 12
115 
116 /* offsets from start of status_t */
117 /* card to host */
118 #define STATUS_OPEN		0
119 #define STATUS_CABLE		(STATUS_OPEN + 4)
120 #define STATUS_RX_OVERRUNS	(STATUS_CABLE + 4)
121 #define STATUS_RX_FRAME_ERRORS	(STATUS_RX_OVERRUNS + 4)
122 
123 /* host to card */
124 #define STATUS_PARITY		(STATUS_RX_FRAME_ERRORS + 4)
125 #define STATUS_ENCODING		(STATUS_PARITY + 4)
126 #define STATUS_CLOCKING		(STATUS_ENCODING + 4)
127 #define STATUS_TX_DESCS		(STATUS_CLOCKING + 4)
128 
129 #ifndef __ASSEMBLER__
130 
131 typedef struct {
132 	volatile u32 stat;
133 	u32 address;		/* PCI address */
134 	volatile u32 length;
135 }desc_t;
136 
137 
138 typedef struct {
139 // Card to host
140 	volatile u32 open;
141 	volatile u32 cable;
142 	volatile u32 rx_overruns;
143 	volatile u32 rx_frame_errors;
144 
145 // Host to card
146 	u32 parity;
147 	u32 encoding;
148 	u32 clocking;
149 	desc_t tx_descs[TX_BUFFERS];
150 }port_status_t;
151 
152 #endif /* __ASSEMBLER__ */
153