1 /* r3964 linediscipline for linux
3 * -----------------------------------------------------------
5 * Philips Automation Projects
7 * http://www.pap-philips.de
8 * -----------------------------------------------------------
9 * This software may be used and distributed according to the terms of
10 * the GNU Public License, incorporated herein by reference.
16 * Revision 1.1.1.1 1998/10/13 16:43:14 dwmw2
17 * This'll screw the version control
19 * Revision 1.6 1998/09/30 00:40:38 dwmw2
20 * Updated to use kernel's N_R3964 if available
22 * Revision 1.4 1998/04/02 20:29:44 lhaag
23 * select, blocking, ...
25 * Revision 1.3 1998/02/12 18:58:43 root
26 * fixed some memory leaks
27 * calculation of checksum characters
29 * Revision 1.2 1998/02/07 13:03:17 root
32 * Revision 1.1 1998/02/06 19:19:43 root
38 #ifndef __LINUX_N_R3964_H__
39 #define __LINUX_N_R3964_H__
41 /* line disciplines for r3964 protocol */
42 #include <asm/termios.h>
46 * Common ascii handshake characters:
55 * Timeouts (msecs/10 msecs per timer interrupt):
58 #define R3964_TO_QVZ 550/10
59 #define R3964_TO_ZVZ 220/10
60 #define R3964_TO_NO_BUF 400/10
61 #define R3964_NO_TX_ROOM 100/10
62 #define R3964_TO_RX_PANIC 4000/10
63 #define R3964_MAX_RETRIES 5
71 #define R3964_ENABLE_SIGNALS 0x5301
72 #define R3964_SETPRIORITY 0x5302
73 #define R3964_USE_BCC 0x5303
74 #define R3964_READ_TELEGRAM 0x5304
76 /* Options for R3964_SETPRIORITY */
77 #define R3964_MASTER 0
80 /* Options for R3964_ENABLE_SIGNALS */
81 #define R3964_SIG_ACK 0x0001
82 #define R3964_SIG_DATA 0x0002
83 #define R3964_SIG_ALL 0x000f
84 #define R3964_SIG_NONE 0x0000
85 #define R3964_USE_SIGIO 0x1000
88 * r3964 operation states:
93 R3964_TX_REQUEST
, R3964_TRANSMITTING
,
94 R3964_WAIT_ZVZ_BEFORE_TX_RETRY
, R3964_WAIT_FOR_TX_ACK
,
95 R3964_WAIT_FOR_RX_BUF
,
96 R3964_RECEIVING
, R3964_WAIT_FOR_BCC
, R3964_WAIT_FOR_RX_REPEAT
100 * All open file-handles are 'clients' and are stored in a linked list:
103 struct r3964_message
;
105 struct r3964_client_info
{
107 unsigned int sig_flags
;
109 struct r3964_client_info
*next
;
111 struct r3964_message
*first_msg
;
112 struct r3964_message
*last_msg
;
113 struct r3964_block_header
*next_block_to_read
;
120 /* types for msg_id: */
121 enum {R3964_MSG_ACK
=1, R3964_MSG_DATA
};
123 #define R3964_MAX_MSG_COUNT 32
125 /* error codes for client messages */
126 #define R3964_OK 0 /* no error. */
127 #define R3964_TX_FAIL -1 /* transmission error, block NOT sent */
128 #define R3964_OVERFLOW -2 /* msg queue overflow */
130 /* the client gets this struct when calling read(fd,...): */
131 struct r3964_client_message
{
137 #define R3964_MTU 256
142 struct r3964_block_header
;
144 /* internal version of client_message: */
145 struct r3964_message
{
149 struct r3964_block_header
*block
;
150 struct r3964_message
*next
;
154 * Header of received block in rx_buf/tx_buf:
157 struct r3964_block_header
159 unsigned int length
; /* length in chars without header */
160 unsigned char *data
; /* usually data is located
161 immediatly behind this struct */
162 unsigned int locks
; /* only used in rx_buffer */
164 struct r3964_block_header
*next
;
165 struct r3964_client_info
*owner
; /* =NULL in rx_buffer */
169 * If rx_buf hasn't enough space to store R3964_MTU chars,
170 * we will reject all incoming STX-requests by sending NAK.
173 #define RX_BUF_SIZE 4000
174 #define TX_BUF_SIZE 4000
175 #define R3964_MAX_BLOCKS_IN_RX_QUEUE 100
177 #define R3964_PARITY 0x0001
178 #define R3964_FRAME 0x0002
179 #define R3964_OVERRUN 0x0004
180 #define R3964_UNKNOWN 0x0008
181 #define R3964_BREAK 0x0010
182 #define R3964_CHECKSUM 0x0020
183 #define R3964_ERROR 0x003f
184 #define R3964_BCC 0x4000
185 #define R3964_DEBUG 0x8000
189 struct tty_struct
*tty
;
190 unsigned char priority
;
191 unsigned char *rx_buf
; /* ring buffer */
192 unsigned char *tx_buf
;
194 wait_queue_head_t read_wait
;
195 //struct wait_queue *read_wait;
197 struct r3964_block_header
*rx_first
;
198 struct r3964_block_header
*rx_last
;
199 struct r3964_block_header
*tx_first
;
200 struct r3964_block_header
*tx_last
;
201 unsigned int tx_position
;
202 unsigned int rx_position
;
203 unsigned char last_rx
;
205 unsigned int blocks_in_rx_queue
;
208 struct r3964_client_info
*firstClient
;
215 struct tq_struct bh_1
;
216 struct tq_struct bh_2
;