]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - drivers/tty/serial/pmac_zilog.h
License cleanup: add SPDX GPL-2.0 license identifier to files with no license
[mirror_ubuntu-eoan-kernel.git] / drivers / tty / serial / pmac_zilog.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef __PMAC_ZILOG_H__
3#define __PMAC_ZILOG_H__
4
1da177e4
LT
5/*
6 * At most 2 ESCCs with 2 ports each
7 */
8#define MAX_ZS_PORTS 4
9
10/*
11 * We wrap our port structure around the generic uart_port.
12 */
13#define NUM_ZSREGS 17
14
15struct uart_pmac_port {
16 struct uart_port port;
17 struct uart_pmac_port *mate;
18
ec9cbe09 19#ifdef CONFIG_PPC_PMAC
1da177e4
LT
20 /* macio_dev for the escc holding this port (maybe be null on
21 * early inited port)
22 */
23 struct macio_dev *dev;
24 /* device node to this port, this points to one of 2 childs
25 * of "escc" node (ie. ch-a or ch-b)
26 */
27 struct device_node *node;
ec9cbe09 28#else
a79dd5ae 29 struct platform_device *pdev;
ec9cbe09 30#endif
1da177e4
LT
31
32 /* Port type as obtained from device tree (IRDA, modem, ...) */
33 int port_type;
34 u8 curregs[NUM_ZSREGS];
35
36 unsigned int flags;
37#define PMACZILOG_FLAG_IS_CONS 0x00000001
38#define PMACZILOG_FLAG_IS_KGDB 0x00000002
39#define PMACZILOG_FLAG_MODEM_STATUS 0x00000004
40#define PMACZILOG_FLAG_IS_CHANNEL_A 0x00000008
41#define PMACZILOG_FLAG_REGS_HELD 0x00000010
42#define PMACZILOG_FLAG_TX_STOPPED 0x00000020
43#define PMACZILOG_FLAG_TX_ACTIVE 0x00000040
1da177e4
LT
44#define PMACZILOG_FLAG_IS_IRDA 0x00000100
45#define PMACZILOG_FLAG_IS_INTMODEM 0x00000200
46#define PMACZILOG_FLAG_HAS_DMA 0x00000400
47#define PMACZILOG_FLAG_RSRC_REQUESTED 0x00000800
1da177e4 48#define PMACZILOG_FLAG_IS_OPEN 0x00002000
1da177e4
LT
49#define PMACZILOG_FLAG_IS_EXTCLK 0x00008000
50#define PMACZILOG_FLAG_BREAK 0x00010000
51
52 unsigned char parity_mask;
53 unsigned char prev_status;
54
55 volatile u8 __iomem *control_reg;
56 volatile u8 __iomem *data_reg;
57
ec9cbe09 58#ifdef CONFIG_PPC_PMAC
1da177e4
LT
59 unsigned int tx_dma_irq;
60 unsigned int rx_dma_irq;
61 volatile struct dbdma_regs __iomem *tx_dma_regs;
62 volatile struct dbdma_regs __iomem *rx_dma_regs;
ec9cbe09 63#endif
1da177e4 64
a79dd5ae
BH
65 unsigned char irq_name[8];
66
606d099c 67 struct ktermios termios_cache;
1da177e4
LT
68};
69
70#define to_pmz(p) ((struct uart_pmac_port *)(p))
71
72static inline struct uart_pmac_port *pmz_get_port_A(struct uart_pmac_port *uap)
73{
74 if (uap->flags & PMACZILOG_FLAG_IS_CHANNEL_A)
75 return uap;
76 return uap->mate;
77}
78
79/*
af901ca1 80 * Register accessors. Note that we don't need to enforce a recovery
1da177e4
LT
81 * delay on PCI PowerMac hardware, it's dealt in HW by the MacIO chip,
82 * though if we try to use this driver on older machines, we might have
83 * to add it back
84 */
85static inline u8 read_zsreg(struct uart_pmac_port *port, u8 reg)
86{
87 if (reg != 0)
88 writeb(reg, port->control_reg);
89 return readb(port->control_reg);
90}
91
92static inline void write_zsreg(struct uart_pmac_port *port, u8 reg, u8 value)
93{
94 if (reg != 0)
95 writeb(reg, port->control_reg);
96 writeb(value, port->control_reg);
97}
98
99static inline u8 read_zsdata(struct uart_pmac_port *port)
100{
101 return readb(port->data_reg);
102}
103
104static inline void write_zsdata(struct uart_pmac_port *port, u8 data)
105{
106 writeb(data, port->data_reg);
107}
108
109static inline void zssync(struct uart_pmac_port *port)
110{
111 (void)readb(port->control_reg);
112}
113
114/* Conversion routines to/from brg time constants from/to bits
115 * per second.
116 */
117#define BRG_TO_BPS(brg, freq) ((freq) / 2 / ((brg) + 2))
118#define BPS_TO_BRG(bps, freq) ((((freq) + (bps)) / (2 * (bps))) - 2)
119
1f7b5fff 120#define ZS_CLOCK 3686400 /* Z8530 RTxC input clock rate */
1da177e4
LT
121
122/* The Zilog register set */
123
124#define FLAG 0x7e
125
126/* Write Register 0 */
127#define R0 0 /* Register selects */
128#define R1 1
129#define R2 2
130#define R3 3
131#define R4 4
132#define R5 5
133#define R6 6
134#define R7 7
135#define R8 8
136#define R9 9
137#define R10 10
138#define R11 11
139#define R12 12
140#define R13 13
141#define R14 14
142#define R15 15
143#define R7P 16
144
145#define NULLCODE 0 /* Null Code */
146#define POINT_HIGH 0x8 /* Select upper half of registers */
147#define RES_EXT_INT 0x10 /* Reset Ext. Status Interrupts */
148#define SEND_ABORT 0x18 /* HDLC Abort */
149#define RES_RxINT_FC 0x20 /* Reset RxINT on First Character */
150#define RES_Tx_P 0x28 /* Reset TxINT Pending */
151#define ERR_RES 0x30 /* Error Reset */
152#define RES_H_IUS 0x38 /* Reset highest IUS */
153
154#define RES_Rx_CRC 0x40 /* Reset Rx CRC Checker */
155#define RES_Tx_CRC 0x80 /* Reset Tx CRC Checker */
156#define RES_EOM_L 0xC0 /* Reset EOM latch */
157
158/* Write Register 1 */
159
160#define EXT_INT_ENAB 0x1 /* Ext Int Enable */
161#define TxINT_ENAB 0x2 /* Tx Int Enable */
162#define PAR_SPEC 0x4 /* Parity is special condition */
163
164#define RxINT_DISAB 0 /* Rx Int Disable */
165#define RxINT_FCERR 0x8 /* Rx Int on First Character Only or Error */
166#define INT_ALL_Rx 0x10 /* Int on all Rx Characters or error */
167#define INT_ERR_Rx 0x18 /* Int on error only */
168#define RxINT_MASK 0x18
169
170#define WT_RDY_RT 0x20 /* W/Req reflects recv if 1, xmit if 0 */
171#define WT_FN_RDYFN 0x40 /* W/Req pin is DMA request if 1, wait if 0 */
172#define WT_RDY_ENAB 0x80 /* Enable W/Req pin */
173
174/* Write Register #2 (Interrupt Vector) */
175
176/* Write Register 3 */
177
1f7b5fff 178#define RxENABLE 0x1 /* Rx Enable */
1da177e4
LT
179#define SYNC_L_INH 0x2 /* Sync Character Load Inhibit */
180#define ADD_SM 0x4 /* Address Search Mode (SDLC) */
181#define RxCRC_ENAB 0x8 /* Rx CRC Enable */
182#define ENT_HM 0x10 /* Enter Hunt Mode */
183#define AUTO_ENAB 0x20 /* Auto Enables */
184#define Rx5 0x0 /* Rx 5 Bits/Character */
185#define Rx7 0x40 /* Rx 7 Bits/Character */
186#define Rx6 0x80 /* Rx 6 Bits/Character */
187#define Rx8 0xc0 /* Rx 8 Bits/Character */
188#define RxN_MASK 0xc0
189
190/* Write Register 4 */
191
1f7b5fff 192#define PAR_ENAB 0x1 /* Parity Enable */
1da177e4
LT
193#define PAR_EVEN 0x2 /* Parity Even/Odd* */
194
195#define SYNC_ENAB 0 /* Sync Modes Enable */
196#define SB1 0x4 /* 1 stop bit/char */
197#define SB15 0x8 /* 1.5 stop bits/char */
198#define SB2 0xc /* 2 stop bits/char */
199#define SB_MASK 0xc
200
201#define MONSYNC 0 /* 8 Bit Sync character */
202#define BISYNC 0x10 /* 16 bit sync character */
203#define SDLC 0x20 /* SDLC Mode (01111110 Sync Flag) */
204#define EXTSYNC 0x30 /* External Sync Mode */
205
206#define X1CLK 0x0 /* x1 clock mode */
207#define X16CLK 0x40 /* x16 clock mode */
208#define X32CLK 0x80 /* x32 clock mode */
209#define X64CLK 0xC0 /* x64 clock mode */
210#define XCLK_MASK 0xC0
211
212/* Write Register 5 */
213
214#define TxCRC_ENAB 0x1 /* Tx CRC Enable */
215#define RTS 0x2 /* RTS */
216#define SDLC_CRC 0x4 /* SDLC/CRC-16 */
1f7b5fff 217#define TxENABLE 0x8 /* Tx Enable */
1da177e4
LT
218#define SND_BRK 0x10 /* Send Break */
219#define Tx5 0x0 /* Tx 5 bits (or less)/character */
220#define Tx7 0x20 /* Tx 7 bits/character */
221#define Tx6 0x40 /* Tx 6 bits/character */
222#define Tx8 0x60 /* Tx 8 bits/character */
223#define TxN_MASK 0x60
224#define DTR 0x80 /* DTR */
225
226/* Write Register 6 (Sync bits 0-7/SDLC Address Field) */
227
228/* Write Register 7 (Sync bits 8-15/SDLC 01111110) */
229
230/* Write Register 7' (Some enhanced feature control) */
231#define ENEXREAD 0x40 /* Enable read of some write registers */
232
233/* Write Register 8 (transmit buffer) */
234
235/* Write Register 9 (Master interrupt control) */
236#define VIS 1 /* Vector Includes Status */
237#define NV 2 /* No Vector */
238#define DLC 4 /* Disable Lower Chain */
239#define MIE 8 /* Master Interrupt Enable */
240#define STATHI 0x10 /* Status high */
241#define NORESET 0 /* No reset on write to R9 */
242#define CHRB 0x40 /* Reset channel B */
243#define CHRA 0x80 /* Reset channel A */
244#define FHWRES 0xc0 /* Force hardware reset */
245
246/* Write Register 10 (misc control bits) */
247#define BIT6 1 /* 6 bit/8bit sync */
248#define LOOPMODE 2 /* SDLC Loop mode */
249#define ABUNDER 4 /* Abort/flag on SDLC xmit underrun */
250#define MARKIDLE 8 /* Mark/flag on idle */
251#define GAOP 0x10 /* Go active on poll */
252#define NRZ 0 /* NRZ mode */
253#define NRZI 0x20 /* NRZI mode */
254#define FM1 0x40 /* FM1 (transition = 1) */
255#define FM0 0x60 /* FM0 (transition = 0) */
256#define CRCPS 0x80 /* CRC Preset I/O */
257
258/* Write Register 11 (Clock Mode control) */
259#define TRxCXT 0 /* TRxC = Xtal output */
260#define TRxCTC 1 /* TRxC = Transmit clock */
261#define TRxCBR 2 /* TRxC = BR Generator Output */
262#define TRxCDP 3 /* TRxC = DPLL output */
263#define TRxCOI 4 /* TRxC O/I */
264#define TCRTxCP 0 /* Transmit clock = RTxC pin */
265#define TCTRxCP 8 /* Transmit clock = TRxC pin */
266#define TCBR 0x10 /* Transmit clock = BR Generator output */
267#define TCDPLL 0x18 /* Transmit clock = DPLL output */
268#define RCRTxCP 0 /* Receive clock = RTxC pin */
269#define RCTRxCP 0x20 /* Receive clock = TRxC pin */
270#define RCBR 0x40 /* Receive clock = BR Generator output */
271#define RCDPLL 0x60 /* Receive clock = DPLL output */
272#define RTxCX 0x80 /* RTxC Xtal/No Xtal */
273
274/* Write Register 12 (lower byte of baud rate generator time constant) */
275
276/* Write Register 13 (upper byte of baud rate generator time constant) */
277
278/* Write Register 14 (Misc control bits) */
279#define BRENAB 1 /* Baud rate generator enable */
280#define BRSRC 2 /* Baud rate generator source */
281#define DTRREQ 4 /* DTR/Request function */
282#define AUTOECHO 8 /* Auto Echo */
283#define LOOPBAK 0x10 /* Local loopback */
284#define SEARCH 0x20 /* Enter search mode */
285#define RMC 0x40 /* Reset missing clock */
286#define DISDPLL 0x60 /* Disable DPLL */
287#define SSBR 0x80 /* Set DPLL source = BR generator */
288#define SSRTxC 0xa0 /* Set DPLL source = RTxC */
289#define SFMM 0xc0 /* Set FM mode */
290#define SNRZI 0xe0 /* Set NRZI mode */
291
292/* Write Register 15 (external/status interrupt control) */
293#define EN85C30 1 /* Enable some 85c30-enhanced registers */
294#define ZCIE 2 /* Zero count IE */
295#define ENSTFIFO 4 /* Enable status FIFO (SDLC) */
296#define DCDIE 8 /* DCD IE */
297#define SYNCIE 0x10 /* Sync/hunt IE */
298#define CTSIE 0x20 /* CTS IE */
299#define TxUIE 0x40 /* Tx Underrun/EOM IE */
300#define BRKIE 0x80 /* Break/Abort IE */
301
302
303/* Read Register 0 */
304#define Rx_CH_AV 0x1 /* Rx Character Available */
305#define ZCOUNT 0x2 /* Zero count */
306#define Tx_BUF_EMP 0x4 /* Tx Buffer empty */
307#define DCD 0x8 /* DCD */
308#define SYNC_HUNT 0x10 /* Sync/hunt */
309#define CTS 0x20 /* CTS */
310#define TxEOM 0x40 /* Tx underrun */
311#define BRK_ABRT 0x80 /* Break/Abort */
312
313/* Read Register 1 */
314#define ALL_SNT 0x1 /* All sent */
315/* Residue Data for 8 Rx bits/char programmed */
316#define RES3 0x8 /* 0/3 */
317#define RES4 0x4 /* 0/4 */
318#define RES5 0xc /* 0/5 */
319#define RES6 0x2 /* 0/6 */
320#define RES7 0xa /* 0/7 */
321#define RES8 0x6 /* 0/8 */
322#define RES18 0xe /* 1/8 */
323#define RES28 0x0 /* 2/8 */
324/* Special Rx Condition Interrupts */
325#define PAR_ERR 0x10 /* Parity error */
326#define Rx_OVR 0x20 /* Rx Overrun Error */
327#define CRC_ERR 0x40 /* CRC/Framing Error */
328#define END_FR 0x80 /* End of Frame (SDLC) */
329
330/* Read Register 2 (channel b only) - Interrupt vector */
331#define CHB_Tx_EMPTY 0x00
332#define CHB_EXT_STAT 0x02
333#define CHB_Rx_AVAIL 0x04
334#define CHB_SPECIAL 0x06
335#define CHA_Tx_EMPTY 0x08
336#define CHA_EXT_STAT 0x0a
337#define CHA_Rx_AVAIL 0x0c
338#define CHA_SPECIAL 0x0e
339#define STATUS_MASK 0x06
340
341/* Read Register 3 (interrupt pending register) ch a only */
342#define CHBEXT 0x1 /* Channel B Ext/Stat IP */
343#define CHBTxIP 0x2 /* Channel B Tx IP */
344#define CHBRxIP 0x4 /* Channel B Rx IP */
345#define CHAEXT 0x8 /* Channel A Ext/Stat IP */
346#define CHATxIP 0x10 /* Channel A Tx IP */
347#define CHARxIP 0x20 /* Channel A Rx IP */
348
349/* Read Register 8 (receive data register) */
350
351/* Read Register 10 (misc status bits) */
352#define ONLOOP 2 /* On loop */
353#define LOOPSEND 0x10 /* Loop sending */
354#define CLK2MIS 0x40 /* Two clocks missing */
355#define CLK1MIS 0x80 /* One clock missing */
356
357/* Read Register 12 (lower byte of baud rate generator constant) */
358
359/* Read Register 13 (upper byte of baud rate generator constant) */
360
361/* Read Register 15 (value of WR 15) */
362
363/* Misc macros */
364#define ZS_CLEARERR(port) (write_zsreg(port, 0, ERR_RES))
365#define ZS_CLEARFIFO(port) do { volatile unsigned char garbage; \
366 garbage = read_zsdata(port); \
367 garbage = read_zsdata(port); \
368 garbage = read_zsdata(port); \
369 } while(0)
370
371#define ZS_IS_CONS(UP) ((UP)->flags & PMACZILOG_FLAG_IS_CONS)
372#define ZS_IS_KGDB(UP) ((UP)->flags & PMACZILOG_FLAG_IS_KGDB)
373#define ZS_IS_CHANNEL_A(UP) ((UP)->flags & PMACZILOG_FLAG_IS_CHANNEL_A)
374#define ZS_REGS_HELD(UP) ((UP)->flags & PMACZILOG_FLAG_REGS_HELD)
375#define ZS_TX_STOPPED(UP) ((UP)->flags & PMACZILOG_FLAG_TX_STOPPED)
376#define ZS_TX_ACTIVE(UP) ((UP)->flags & PMACZILOG_FLAG_TX_ACTIVE)
377#define ZS_WANTS_MODEM_STATUS(UP) ((UP)->flags & PMACZILOG_FLAG_MODEM_STATUS)
378#define ZS_IS_IRDA(UP) ((UP)->flags & PMACZILOG_FLAG_IS_IRDA)
1f7b5fff 379#define ZS_IS_INTMODEM(UP) ((UP)->flags & PMACZILOG_FLAG_IS_INTMODEM)
1da177e4 380#define ZS_HAS_DMA(UP) ((UP)->flags & PMACZILOG_FLAG_HAS_DMA)
1f7b5fff 381#define ZS_IS_OPEN(UP) ((UP)->flags & PMACZILOG_FLAG_IS_OPEN)
1f7b5fff 382#define ZS_IS_EXTCLK(UP) ((UP)->flags & PMACZILOG_FLAG_IS_EXTCLK)
1da177e4
LT
383
384#endif /* __PMAC_ZILOG_H__ */