aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/serial/jsm/jsm.h
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@ppc970.osdl.org>2005-04-16 18:20:36 -0400
committerLinus Torvalds <torvalds@ppc970.osdl.org>2005-04-16 18:20:36 -0400
commit1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 (patch)
tree0bba044c4ce775e45a88a51686b5d9f90697ea9d /drivers/serial/jsm/jsm.h
Linux-2.6.12-rc2v2.6.12-rc2
Initial git repository build. I'm not bothering with the full history, even though we have it. We can create a separate "historical" git archive of that later if we want to, and in the meantime it's about 3.2GB when imported into git - space that would just make the early git days unnecessarily complicated, when we don't have a lot of good infrastructure for it. Let it rip!
Diffstat (limited to 'drivers/serial/jsm/jsm.h')
-rw-r--r--drivers/serial/jsm/jsm.h437
1 files changed, 437 insertions, 0 deletions
diff --git a/drivers/serial/jsm/jsm.h b/drivers/serial/jsm/jsm.h
new file mode 100644
index 000000000000..b12ee02a0f7c
--- /dev/null
+++ b/drivers/serial/jsm/jsm.h
@@ -0,0 +1,437 @@
1/************************************************************************
2 * Copyright 2003 Digi International (www.digi.com)
3 *
4 * Copyright (C) 2004 IBM Corporation. All rights reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
9 * any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED; without even the
13 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 * Temple Place - Suite 330, Boston,
19 * MA 02111-1307, USA.
20 *
21 * Contact Information:
22 * Scott H Kilau <Scott_Kilau@digi.com>
23 * Wendy Xiong <wendyx@us.ltcfwd.linux.ibm.com>
24 *
25 ***********************************************************************/
26
27#ifndef __JSM_DRIVER_H
28#define __JSM_DRIVER_H
29
30#include <linux/kernel.h>
31#include <linux/version.h>
32#include <linux/types.h> /* To pick up the varions Linux types */
33#include <linux/tty.h>
34#include <linux/serial_core.h>
35#include <linux/device.h>
36
37/*
38 * Debugging levels can be set using debug insmod variable
39 * They can also be compiled out completely.
40 */
41enum {
42 DBG_INIT = 0x01,
43 DBG_BASIC = 0x02,
44 DBG_CORE = 0x04,
45 DBG_OPEN = 0x08,
46 DBG_CLOSE = 0x10,
47 DBG_READ = 0x20,
48 DBG_WRITE = 0x40,
49 DBG_IOCTL = 0x80,
50 DBG_PROC = 0x100,
51 DBG_PARAM = 0x200,
52 DBG_PSCAN = 0x400,
53 DBG_EVENT = 0x800,
54 DBG_DRAIN = 0x1000,
55 DBG_MSIGS = 0x2000,
56 DBG_MGMT = 0x4000,
57 DBG_INTR = 0x8000,
58 DBG_CARR = 0x10000,
59};
60
61#define jsm_printk(nlevel, klevel, pdev, fmt, args...) \
62 if ((DBG_##nlevel & jsm_debug)) \
63 dev_printk(KERN_##klevel, pdev->dev, fmt, ## args)
64
65#define MAXPORTS 8
66#define MAX_STOPS_SENT 5
67
68/* Board type definitions */
69
70#define T_NEO 0000
71#define T_CLASSIC 0001
72#define T_PCIBUS 0400
73
74/* Board State Definitions */
75
76#define BD_RUNNING 0x0
77#define BD_REASON 0x7f
78#define BD_NOTFOUND 0x1
79#define BD_NOIOPORT 0x2
80#define BD_NOMEM 0x3
81#define BD_NOBIOS 0x4
82#define BD_NOFEP 0x5
83#define BD_FAILED 0x6
84#define BD_ALLOCATED 0x7
85#define BD_TRIBOOT 0x8
86#define BD_BADKME 0x80
87
88
89/* 4 extra for alignment play space */
90#define WRITEBUFLEN ((4096) + 4)
91#define MYFLIPLEN N_TTY_BUF_SIZE
92
93#define JSM_VERSION "jsm: 1.1-1-INKERNEL"
94#define JSM_PARTNUM "40002438_A-INKERNEL"
95
96/*
97 * All the possible states the driver can be while being loaded.
98 */
99enum {
100 DRIVER_INITIALIZED = 0,
101 DRIVER_READY
102};
103
104/*
105 * All the possible states the board can be while booting up.
106 */
107enum {
108 BOARD_FAILED = 0,
109 BOARD_FOUND,
110 BOARD_READY
111};
112
113struct board_id {
114 u8 *name;
115 u32 maxports;
116};
117
118struct jsm_board;
119struct jsm_channel;
120
121/************************************************************************
122 * Per board operations structure *
123 ************************************************************************/
124struct board_ops {
125 irqreturn_t (*intr) (int irq, void *voidbrd, struct pt_regs *regs);
126 void (*uart_init) (struct jsm_channel *ch);
127 void (*uart_off) (struct jsm_channel *ch);
128 void (*param) (struct jsm_channel *ch);
129 void (*assert_modem_signals) (struct jsm_channel *ch);
130 void (*flush_uart_write) (struct jsm_channel *ch);
131 void (*flush_uart_read) (struct jsm_channel *ch);
132 void (*disable_receiver) (struct jsm_channel *ch);
133 void (*enable_receiver) (struct jsm_channel *ch);
134 void (*send_break) (struct jsm_channel *ch);
135 void (*clear_break) (struct jsm_channel *ch, int);
136 void (*send_start_character) (struct jsm_channel *ch);
137 void (*send_stop_character) (struct jsm_channel *ch);
138 void (*copy_data_from_queue_to_uart) (struct jsm_channel *ch);
139 u32 (*get_uart_bytes_left) (struct jsm_channel *ch);
140 void (*send_immediate_char) (struct jsm_channel *ch, unsigned char);
141};
142
143
144/*
145 * Per-board information
146 */
147struct jsm_board
148{
149 int boardnum; /* Board number: 0-32 */
150
151 int type; /* Type of board */
152 char *name; /* Product Name */
153 u8 rev; /* PCI revision ID */
154 struct pci_dev *pci_dev;
155 u32 maxports; /* MAX ports this board can handle */
156
157 spinlock_t bd_lock; /* Used to protect board */
158
159 spinlock_t bd_intr_lock; /* Used to protect the poller tasklet and
160 * the interrupt routine from each other.
161 */
162
163 u32 state; /* State of card. */
164 wait_queue_head_t state_wait; /* Place to sleep on for state change */
165
166 u32 nasync; /* Number of ports on card */
167
168 u32 irq; /* Interrupt request number */
169 u64 intr_count; /* Count of interrupts */
170
171 u64 membase; /* Start of base memory of the card */
172 u64 membase_end; /* End of base memory of the card */
173
174 u8 __iomem *re_map_membase;/* Remapped memory of the card */
175
176 u64 iobase; /* Start of io base of the card */
177 u64 iobase_end; /* End of io base of the card */
178
179 u32 bd_uart_offset; /* Space between each UART */
180
181 struct jsm_channel *channels[MAXPORTS]; /* array of pointers to our channels. */
182 char *flipbuf; /* Our flip buffer, alloced if board is found */
183
184 u16 dpatype; /* The board "type", as defined by DPA */
185 u16 dpastatus; /* The board "status", as defined by DPA */
186
187 u32 bd_dividend; /* Board/UARTs specific dividend */
188
189 struct board_ops *bd_ops;
190
191 struct list_head jsm_board_entry;
192};
193
194/************************************************************************
195 * Device flag definitions for ch_flags.
196 ************************************************************************/
197#define CH_PRON 0x0001 /* Printer on string */
198#define CH_STOP 0x0002 /* Output is stopped */
199#define CH_STOPI 0x0004 /* Input is stopped */
200#define CH_CD 0x0008 /* Carrier is present */
201#define CH_FCAR 0x0010 /* Carrier forced on */
202#define CH_HANGUP 0x0020 /* Hangup received */
203
204#define CH_RECEIVER_OFF 0x0040 /* Receiver is off */
205#define CH_OPENING 0x0080 /* Port in fragile open state */
206#define CH_CLOSING 0x0100 /* Port in fragile close state */
207#define CH_FIFO_ENABLED 0x0200 /* Port has FIFOs enabled */
208#define CH_TX_FIFO_EMPTY 0x0400 /* TX Fifo is completely empty */
209#define CH_TX_FIFO_LWM 0x0800 /* TX Fifo is below Low Water */
210#define CH_BREAK_SENDING 0x1000 /* Break is being sent */
211#define CH_LOOPBACK 0x2000 /* Channel is in lookback mode */
212#define CH_FLIPBUF_IN_USE 0x4000 /* Channel's flipbuf is in use */
213#define CH_BAUD0 0x08000 /* Used for checking B0 transitions */
214
215/* Our Read/Error/Write queue sizes */
216#define RQUEUEMASK 0x1FFF /* 8 K - 1 */
217#define EQUEUEMASK 0x1FFF /* 8 K - 1 */
218#define WQUEUEMASK 0x0FFF /* 4 K - 1 */
219#define RQUEUESIZE (RQUEUEMASK + 1)
220#define EQUEUESIZE RQUEUESIZE
221#define WQUEUESIZE (WQUEUEMASK + 1)
222
223
224/************************************************************************
225 * Channel information structure.
226 ************************************************************************/
227struct jsm_channel {
228 struct uart_port uart_port;
229 struct jsm_board *ch_bd; /* Board structure pointer */
230
231 spinlock_t ch_lock; /* provide for serialization */
232 wait_queue_head_t ch_flags_wait;
233
234 u32 ch_portnum; /* Port number, 0 offset. */
235 u32 ch_open_count; /* open count */
236 u32 ch_flags; /* Channel flags */
237
238 u64 ch_close_delay; /* How long we should drop RTS/DTR for */
239
240 u64 ch_cpstime; /* Time for CPS calculations */
241
242 tcflag_t ch_c_iflag; /* channel iflags */
243 tcflag_t ch_c_cflag; /* channel cflags */
244 tcflag_t ch_c_oflag; /* channel oflags */
245 tcflag_t ch_c_lflag; /* channel lflags */
246 u8 ch_stopc; /* Stop character */
247 u8 ch_startc; /* Start character */
248
249 u32 ch_old_baud; /* Cache of the current baud */
250 u32 ch_custom_speed;/* Custom baud, if set */
251
252 u32 ch_wopen; /* Waiting for open process cnt */
253
254 u8 ch_mostat; /* FEP output modem status */
255 u8 ch_mistat; /* FEP input modem status */
256
257 struct neo_uart_struct __iomem *ch_neo_uart; /* Pointer to the "mapped" UART struct */
258 u8 ch_cached_lsr; /* Cached value of the LSR register */
259
260 u8 *ch_rqueue; /* Our read queue buffer - malloc'ed */
261 u16 ch_r_head; /* Head location of the read queue */
262 u16 ch_r_tail; /* Tail location of the read queue */
263
264 u8 *ch_equeue; /* Our error queue buffer - malloc'ed */
265 u16 ch_e_head; /* Head location of the error queue */
266 u16 ch_e_tail; /* Tail location of the error queue */
267
268 u8 *ch_wqueue; /* Our write queue buffer - malloc'ed */
269 u16 ch_w_head; /* Head location of the write queue */
270 u16 ch_w_tail; /* Tail location of the write queue */
271
272 u64 ch_rxcount; /* total of data received so far */
273 u64 ch_txcount; /* total of data transmitted so far */
274
275 u8 ch_r_tlevel; /* Receive Trigger level */
276 u8 ch_t_tlevel; /* Transmit Trigger level */
277
278 u8 ch_r_watermark; /* Receive Watermark */
279
280
281 u32 ch_stops_sent; /* How many times I have sent a stop character
282 * to try to stop the other guy sending.
283 */
284 u64 ch_err_parity; /* Count of parity errors on channel */
285 u64 ch_err_frame; /* Count of framing errors on channel */
286 u64 ch_err_break; /* Count of breaks on channel */
287 u64 ch_err_overrun; /* Count of overruns on channel */
288
289 u64 ch_xon_sends; /* Count of xons transmitted */
290 u64 ch_xoff_sends; /* Count of xoffs transmitted */
291};
292
293
294/************************************************************************
295 * Per channel/port NEO UART structure *
296 ************************************************************************
297 * Base Structure Entries Usage Meanings to Host *
298 * *
299 * W = read write R = read only *
300 * U = Unused. *
301 ************************************************************************/
302
303struct neo_uart_struct {
304 u8 txrx; /* WR RHR/THR - Holding Reg */
305 u8 ier; /* WR IER - Interrupt Enable Reg */
306 u8 isr_fcr; /* WR ISR/FCR - Interrupt Status Reg/Fifo Control Reg */
307 u8 lcr; /* WR LCR - Line Control Reg */
308 u8 mcr; /* WR MCR - Modem Control Reg */
309 u8 lsr; /* WR LSR - Line Status Reg */
310 u8 msr; /* WR MSR - Modem Status Reg */
311 u8 spr; /* WR SPR - Scratch Pad Reg */
312 u8 fctr; /* WR FCTR - Feature Control Reg */
313 u8 efr; /* WR EFR - Enhanced Function Reg */
314 u8 tfifo; /* WR TXCNT/TXTRG - Transmit FIFO Reg */
315 u8 rfifo; /* WR RXCNT/RXTRG - Recieve FIFO Reg */
316 u8 xoffchar1; /* WR XOFF 1 - XOff Character 1 Reg */
317 u8 xoffchar2; /* WR XOFF 2 - XOff Character 2 Reg */
318 u8 xonchar1; /* WR XON 1 - Xon Character 1 Reg */
319 u8 xonchar2; /* WR XON 2 - XOn Character 2 Reg */
320
321 u8 reserved1[0x2ff - 0x200]; /* U Reserved by Exar */
322 u8 txrxburst[64]; /* RW 64 bytes of RX/TX FIFO Data */
323 u8 reserved2[0x37f - 0x340]; /* U Reserved by Exar */
324 u8 rxburst_with_errors[64]; /* R 64 bytes of RX FIFO Data + LSR */
325};
326
327/* Where to read the extended interrupt register (32bits instead of 8bits) */
328#define UART_17158_POLL_ADDR_OFFSET 0x80
329
330/*
331 * These are the redefinitions for the FCTR on the XR17C158, since
332 * Exar made them different than their earlier design. (XR16C854)
333 */
334
335/* These are only applicable when table D is selected */
336#define UART_17158_FCTR_RTS_NODELAY 0x00
337#define UART_17158_FCTR_RTS_4DELAY 0x01
338#define UART_17158_FCTR_RTS_6DELAY 0x02
339#define UART_17158_FCTR_RTS_8DELAY 0x03
340#define UART_17158_FCTR_RTS_12DELAY 0x12
341#define UART_17158_FCTR_RTS_16DELAY 0x05
342#define UART_17158_FCTR_RTS_20DELAY 0x13
343#define UART_17158_FCTR_RTS_24DELAY 0x06
344#define UART_17158_FCTR_RTS_28DELAY 0x14
345#define UART_17158_FCTR_RTS_32DELAY 0x07
346#define UART_17158_FCTR_RTS_36DELAY 0x16
347#define UART_17158_FCTR_RTS_40DELAY 0x08
348#define UART_17158_FCTR_RTS_44DELAY 0x09
349#define UART_17158_FCTR_RTS_48DELAY 0x10
350#define UART_17158_FCTR_RTS_52DELAY 0x11
351
352#define UART_17158_FCTR_RTS_IRDA 0x10
353#define UART_17158_FCTR_RS485 0x20
354#define UART_17158_FCTR_TRGA 0x00
355#define UART_17158_FCTR_TRGB 0x40
356#define UART_17158_FCTR_TRGC 0x80
357#define UART_17158_FCTR_TRGD 0xC0
358
359/* 17158 trigger table selects.. */
360#define UART_17158_FCTR_BIT6 0x40
361#define UART_17158_FCTR_BIT7 0x80
362
363/* 17158 TX/RX memmapped buffer offsets */
364#define UART_17158_RX_FIFOSIZE 64
365#define UART_17158_TX_FIFOSIZE 64
366
367/* 17158 Extended IIR's */
368#define UART_17158_IIR_RDI_TIMEOUT 0x0C /* Receiver data TIMEOUT */
369#define UART_17158_IIR_XONXOFF 0x10 /* Received an XON/XOFF char */
370#define UART_17158_IIR_HWFLOW_STATE_CHANGE 0x20 /* CTS/DSR or RTS/DTR state change */
371#define UART_17158_IIR_FIFO_ENABLED 0xC0 /* 16550 FIFOs are Enabled */
372
373/*
374 * These are the extended interrupts that get sent
375 * back to us from the UART's 32bit interrupt register
376 */
377#define UART_17158_RX_LINE_STATUS 0x1 /* RX Ready */
378#define UART_17158_RXRDY_TIMEOUT 0x2 /* RX Ready Timeout */
379#define UART_17158_TXRDY 0x3 /* TX Ready */
380#define UART_17158_MSR 0x4 /* Modem State Change */
381#define UART_17158_TX_AND_FIFO_CLR 0x40 /* Transmitter Holding Reg Empty */
382#define UART_17158_RX_FIFO_DATA_ERROR 0x80 /* UART detected an RX FIFO Data error */
383
384/*
385 * These are the EXTENDED definitions for the 17C158's Interrupt
386 * Enable Register.
387 */
388#define UART_17158_EFR_ECB 0x10 /* Enhanced control bit */
389#define UART_17158_EFR_IXON 0x2 /* Receiver compares Xon1/Xoff1 */
390#define UART_17158_EFR_IXOFF 0x8 /* Transmit Xon1/Xoff1 */
391#define UART_17158_EFR_RTSDTR 0x40 /* Auto RTS/DTR Flow Control Enable */
392#define UART_17158_EFR_CTSDSR 0x80 /* Auto CTS/DSR Flow COntrol Enable */
393
394#define UART_17158_XOFF_DETECT 0x1 /* Indicates whether chip saw an incoming XOFF char */
395#define UART_17158_XON_DETECT 0x2 /* Indicates whether chip saw an incoming XON char */
396
397#define UART_17158_IER_RSVD1 0x10 /* Reserved by Exar */
398#define UART_17158_IER_XOFF 0x20 /* Xoff Interrupt Enable */
399#define UART_17158_IER_RTSDTR 0x40 /* Output Interrupt Enable */
400#define UART_17158_IER_CTSDSR 0x80 /* Input Interrupt Enable */
401
402#define PCI_DEVICE_NEO_2DB9_PCI_NAME "Neo 2 - DB9 Universal PCI"
403#define PCI_DEVICE_NEO_2DB9PRI_PCI_NAME "Neo 2 - DB9 Universal PCI - Powered Ring Indicator"
404#define PCI_DEVICE_NEO_2RJ45_PCI_NAME "Neo 2 - RJ45 Universal PCI"
405#define PCI_DEVICE_NEO_2RJ45PRI_PCI_NAME "Neo 2 - RJ45 Universal PCI - Powered Ring Indicator"
406
407/*
408 * Our Global Variables.
409 */
410extern struct uart_driver jsm_uart_driver;
411extern struct board_ops jsm_neo_ops;
412extern int jsm_debug;
413extern int jsm_rawreadok;
414
415extern int jsm_driver_state; /* The state of the driver */
416extern char *jsm_driver_state_text[];/* Array of driver state text */
417
418extern spinlock_t jsm_board_head_lock;
419extern struct list_head jsm_board_head;
420
421/*************************************************************************
422 *
423 * Prototypes for non-static functions used in more than one module
424 *
425 *************************************************************************/
426int jsm_tty_write(struct uart_port *port);
427int jsm_tty_init(struct jsm_board *);
428int jsm_uart_port_init(struct jsm_board *);
429int jsm_remove_uart_port(struct jsm_board *);
430void jsm_input(struct jsm_channel *ch);
431void jsm_carrier(struct jsm_channel *ch);
432void jsm_check_queue_flow_control(struct jsm_channel *ch);
433
434void jsm_create_driver_sysfiles(struct device_driver *);
435void jsm_remove_driver_sysfiles(struct device_driver *);
436
437#endif