n_r3964.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. /* r3964 linediscipline for linux
  2. *
  3. * -----------------------------------------------------------
  4. * Copyright by
  5. * Philips Automation Projects
  6. * Kassel (Germany)
  7. * -----------------------------------------------------------
  8. * This software may be used and distributed according to the terms of
  9. * the GNU General Public License, incorporated herein by reference.
  10. *
  11. * Author:
  12. * L. Haag
  13. *
  14. * $Log: r3964.h,v $
  15. * Revision 1.4 2005/12/21 19:54:24 Kurt Huwig <kurt huwig de>
  16. * Fixed HZ usage on 2.6 kernels
  17. * Removed unnecessary include
  18. *
  19. * Revision 1.3 2001/03/18 13:02:24 dwmw2
  20. * Fix timer usage, use spinlocks properly.
  21. *
  22. * Revision 1.2 2001/03/18 12:53:15 dwmw2
  23. * Merge changes in 2.4.2
  24. *
  25. * Revision 1.1.1.1 1998/10/13 16:43:14 dwmw2
  26. * This'll screw the version control
  27. *
  28. * Revision 1.6 1998/09/30 00:40:38 dwmw2
  29. * Updated to use kernel's N_R3964 if available
  30. *
  31. * Revision 1.4 1998/04/02 20:29:44 lhaag
  32. * select, blocking, ...
  33. *
  34. * Revision 1.3 1998/02/12 18:58:43 root
  35. * fixed some memory leaks
  36. * calculation of checksum characters
  37. *
  38. * Revision 1.2 1998/02/07 13:03:17 root
  39. * ioctl read_telegram
  40. *
  41. * Revision 1.1 1998/02/06 19:19:43 root
  42. * Initial revision
  43. *
  44. *
  45. */
  46. #ifndef __LINUX_N_R3964_H__
  47. #define __LINUX_N_R3964_H__
  48. #include <linux/param.h>
  49. #include <uapi/linux/n_r3964.h>
  50. /*
  51. * Common ascii handshake characters:
  52. */
  53. #define STX 0x02
  54. #define ETX 0x03
  55. #define DLE 0x10
  56. #define NAK 0x15
  57. /*
  58. * Timeouts (from milliseconds to jiffies)
  59. */
  60. #define R3964_TO_QVZ ((550)*HZ/1000)
  61. #define R3964_TO_ZVZ ((220)*HZ/1000)
  62. #define R3964_TO_NO_BUF ((400)*HZ/1000)
  63. #define R3964_NO_TX_ROOM ((100)*HZ/1000)
  64. #define R3964_TO_RX_PANIC ((4000)*HZ/1000)
  65. #define R3964_MAX_RETRIES 5
  66. enum { R3964_IDLE,
  67. R3964_TX_REQUEST, R3964_TRANSMITTING,
  68. R3964_WAIT_ZVZ_BEFORE_TX_RETRY, R3964_WAIT_FOR_TX_ACK,
  69. R3964_WAIT_FOR_RX_BUF,
  70. R3964_RECEIVING, R3964_WAIT_FOR_BCC, R3964_WAIT_FOR_RX_REPEAT
  71. };
  72. /*
  73. * All open file-handles are 'clients' and are stored in a linked list:
  74. */
  75. struct r3964_message;
  76. struct r3964_client_info {
  77. spinlock_t lock;
  78. struct pid *pid;
  79. unsigned int sig_flags;
  80. struct r3964_client_info *next;
  81. struct r3964_message *first_msg;
  82. struct r3964_message *last_msg;
  83. struct r3964_block_header *next_block_to_read;
  84. int msg_count;
  85. };
  86. struct r3964_block_header;
  87. /* internal version of client_message: */
  88. struct r3964_message {
  89. int msg_id;
  90. int arg;
  91. int error_code;
  92. struct r3964_block_header *block;
  93. struct r3964_message *next;
  94. };
  95. /*
  96. * Header of received block in rx_buf/tx_buf:
  97. */
  98. struct r3964_block_header
  99. {
  100. unsigned int length; /* length in chars without header */
  101. unsigned char *data; /* usually data is located
  102. immediately behind this struct */
  103. unsigned int locks; /* only used in rx_buffer */
  104. struct r3964_block_header *next;
  105. struct r3964_client_info *owner; /* =NULL in rx_buffer */
  106. };
  107. /*
  108. * If rx_buf hasn't enough space to store R3964_MTU chars,
  109. * we will reject all incoming STX-requests by sending NAK.
  110. */
  111. #define RX_BUF_SIZE 4000
  112. #define TX_BUF_SIZE 4000
  113. #define R3964_MAX_BLOCKS_IN_RX_QUEUE 100
  114. #define R3964_PARITY 0x0001
  115. #define R3964_FRAME 0x0002
  116. #define R3964_OVERRUN 0x0004
  117. #define R3964_UNKNOWN 0x0008
  118. #define R3964_BREAK 0x0010
  119. #define R3964_CHECKSUM 0x0020
  120. #define R3964_ERROR 0x003f
  121. #define R3964_BCC 0x4000
  122. #define R3964_DEBUG 0x8000
  123. struct r3964_info {
  124. spinlock_t lock;
  125. struct tty_struct *tty;
  126. unsigned char priority;
  127. unsigned char *rx_buf; /* ring buffer */
  128. unsigned char *tx_buf;
  129. struct r3964_block_header *rx_first;
  130. struct r3964_block_header *rx_last;
  131. struct r3964_block_header *tx_first;
  132. struct r3964_block_header *tx_last;
  133. unsigned int tx_position;
  134. unsigned int rx_position;
  135. unsigned char last_rx;
  136. unsigned char bcc;
  137. unsigned int blocks_in_rx_queue;
  138. struct mutex read_lock; /* serialize r3964_read */
  139. struct r3964_client_info *firstClient;
  140. unsigned int state;
  141. unsigned int flags;
  142. struct timer_list tmr;
  143. int nRetry;
  144. };
  145. #endif