rawhdlc.c
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:16k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /* $Id: rawhdlc.c,v 1.1.4.1 2001/11/20 14:19:36 kai Exp $
  2.  *
  3.  * support routines for cards that don't support HDLC
  4.  *
  5.  * Author     Brent Baccala
  6.  * Copyright  by Karsten Keil <keil@isdn4linux.de>
  7.  *            by Brent Baccala <baccala@FreeSoft.org>
  8.  *
  9.  * This software may be used and distributed according to the terms
  10.  * of the GNU General Public License, incorporated herein by reference.
  11.  *
  12.  *
  13.  * Some passive ISDN cards, such as the Traverse NETJet and the AMD 7930,
  14.  * don't perform HDLC encapsulation over the B channel.  Drivers for
  15.  * such cards use support routines in this file to perform B channel HDLC.
  16.  *
  17.  * Bit-synchronous HDLC encapsulation is a means of encapsulating packets
  18.  * over a continuously transmitting serial communications link.
  19.  * It looks like this:
  20.  *
  21.  *      11111111101111110...........0111111011111111111
  22.  *      iiiiiiiiiffffffffdddddddddddffffffffiiiiiiiiiii
  23.  *
  24.  *      i = idle     f = flag     d = data
  25.  *
  26.  * When idle, the channel sends a continuous string of ones (mark
  27.  * idle; illustrated), or a continuous string of flag characters (flag
  28.  * idle).  The beginning of a data frame is marked by a flag character
  29.  * (01111110), then comes the actual data, followed by another flag
  30.  * character, after which another frame may be sent immediately (a
  31.  * single flag may serve as both the end of one frame and the start of
  32.  * the next), or the link may return to idle.  Obviously, the flag
  33.  * character can not appear anywhere in the data (or a false
  34.  * end-of-frame would occur), so the transmitter performs
  35.  * "bit-stuffing" - inserting a zero bit after every five one bits,
  36.  * irregardless of the original bit after the five ones.  Byte
  37.  * ordering is irrelevent at this point - the data is treated as a
  38.  * string of bits, not bytes.  Since no more than 5 ones may now occur
  39.  * in a row, the flag sequence, with its 6 ones, is unique.
  40.  *
  41.  * Upon reception, a zero bit that occur after 5 one bits is simply
  42.  * discarded.  A series of 6 one bits is end-of-frame, and a series of
  43.  * 7 one bits is an abort.  Once bit-stuffing has been corrected for,
  44.  * an integer number of bytes should now be present.  The last two
  45.  * of these bytes form the Frame Check Sequence, a CRC that is verified
  46.  * and then discarded.  Note that bit-stuffing is performed on the FCS
  47.  * just as if it were regular data.
  48.  *
  49.  *
  50.  *
  51.  * int make_raw_hdlc_data(u_char *src, u_int slen,
  52.  *                        u_char *dst, u_int dsize)
  53.  *
  54.  *   Used for transmission.  Copies slen bytes from src to dst, performing
  55.  *   HDLC encapsulation (flag bytes, bit-stuffing, CRC) in the process.
  56.  *   dsize is size of destination buffer, and should be at least
  57.  *   ((6*slen)/5)+5 bytes to ensure adequate space will be available.
  58.  *   Function returns length (in bytes) of valid destination buffer, or
  59.  *   0 upon destination overflow.
  60.  *
  61.  * void init_hdlc_state(struct hdlc_state *stateptr, int mode)
  62.  *
  63.  *   Initializes hdlc_state structure before first call to read_raw_hdlc_data
  64.  *
  65.  *   mode = 0: Sane mode
  66.  *   mode = 1/2: 
  67.  *             Insane mode; NETJet use a shared unsigned int memory block (
  68.  *         with busmaster DMA), the bit pattern of every word is 
  69.  *          <8 B1> <8 B2> <8 Mon> <2 D> <4 C/I> <MX> <MR>
  70.  *        according to Siemens IOM-2 interface, so we have to handle
  71.  *             the src buffer as unsigned int and have to shift/mask the
  72.  *             B-channel bytes.
  73.  *             mode 1 -> B1  mode 2  -> B2 data is used
  74.  *
  75.  * int read_raw_hdlc_data(struct hdlc_state *saved_state,
  76.  *                        u_char *src, u_int slen,
  77.  *                        u_char *dst, u_int dsize)
  78.  *
  79.  *   Used for reception.  Scans source buffer bit-by-bit looking for
  80.  *   valid HDLC frames, which are copied to destination buffer.  HDLC
  81.  *   state information is stored in a structure, which allows this
  82.  *   function to process frames spread across several blocks of raw
  83.  *   HDLC data.  Part of the state information is bit offsets into
  84.  *   the source and destination buffers.
  85.  *
  86.  *   A return value >0 indicates the length of a valid frame, now
  87.  *   stored in the destination buffer.  In this case, the source
  88.  *   buffer might not be completely processed, so this function should
  89.  *   be called again with the same source buffer, possibly with a
  90.  *   different destination buffer.
  91.  *
  92.  *   A return value of zero indicates that the source buffer was
  93.  *   completely processed without finding a valid end-of-packet;
  94.  *   however, we might be in the middle of packet reception, so
  95.  *   the function should be called again with the next block of
  96.  *   raw HDLC data and the same destination buffer.  It is NOT
  97.  *   permitted to change the destination buffer in this case,
  98.  *   since data may already have begun to be stored there.
  99.  *
  100.  *   A return value of -1 indicates some kind of error - destination
  101.  *   buffer overflow, CRC check failed, frame not a multiple of 8
  102.  *   bits.  Destination buffer probably contains invalid data, which
  103.  *   should be discarded.  Call function again with same source buffer
  104.  *   and a new (or same) destination buffer.
  105.  *
  106.  *   Suggested calling sequence:
  107.  *
  108.  *      init_hdlc_state(...);
  109.  *      for (EACH_RAW_DATA_BLOCK) {
  110.  *         while (len = read_raw_hdlc_data(...)) {
  111.  *             if (len == -1) DISCARD_FRAME;
  112.  *             else PROCESS_FRAME;
  113.  *         }
  114.  *      }
  115.  *
  116.  *
  117.  * Test the code in this file as follows:
  118.  *    gcc -DDEBUGME -o rawhdlctest rawhdlc.c
  119.  *    ./rawhdlctest < rawdata
  120.  *
  121.  * The file "rawdata" can be easily generated from a HISAX B-channel
  122.  * hex dump (CF CF CF 02 ...) using the following perl script:
  123.  *
  124.  * while(<>) {
  125.  *     @hexlist = split ' ';
  126.  *     while ($hexstr = shift(@hexlist)) {
  127.  *         printf "%c", hex($hexstr);
  128.  *     }
  129.  * }
  130.  *
  131.  */
  132. #ifdef DEBUGME
  133. #include <stdio.h>
  134. #endif
  135. #include <linux/types.h>
  136. #include <linux/ppp_defs.h>
  137. #include "rawhdlc.h"
  138. /* There's actually an identical copy of this table in the PPP code
  139.  * (ppp_crc16_table), but I don't want this code dependent on PPP
  140.  */
  141. // static 
  142. __u16 fcstab[256] =
  143. {
  144. 0x0000, 0x1189, 0x2312, 0x329b, 0x4624, 0x57ad, 0x6536, 0x74bf,
  145. 0x8c48, 0x9dc1, 0xaf5a, 0xbed3, 0xca6c, 0xdbe5, 0xe97e, 0xf8f7,
  146. 0x1081, 0x0108, 0x3393, 0x221a, 0x56a5, 0x472c, 0x75b7, 0x643e,
  147. 0x9cc9, 0x8d40, 0xbfdb, 0xae52, 0xdaed, 0xcb64, 0xf9ff, 0xe876,
  148. 0x2102, 0x308b, 0x0210, 0x1399, 0x6726, 0x76af, 0x4434, 0x55bd,
  149. 0xad4a, 0xbcc3, 0x8e58, 0x9fd1, 0xeb6e, 0xfae7, 0xc87c, 0xd9f5,
  150. 0x3183, 0x200a, 0x1291, 0x0318, 0x77a7, 0x662e, 0x54b5, 0x453c,
  151. 0xbdcb, 0xac42, 0x9ed9, 0x8f50, 0xfbef, 0xea66, 0xd8fd, 0xc974,
  152. 0x4204, 0x538d, 0x6116, 0x709f, 0x0420, 0x15a9, 0x2732, 0x36bb,
  153. 0xce4c, 0xdfc5, 0xed5e, 0xfcd7, 0x8868, 0x99e1, 0xab7a, 0xbaf3,
  154. 0x5285, 0x430c, 0x7197, 0x601e, 0x14a1, 0x0528, 0x37b3, 0x263a,
  155. 0xdecd, 0xcf44, 0xfddf, 0xec56, 0x98e9, 0x8960, 0xbbfb, 0xaa72,
  156. 0x6306, 0x728f, 0x4014, 0x519d, 0x2522, 0x34ab, 0x0630, 0x17b9,
  157. 0xef4e, 0xfec7, 0xcc5c, 0xddd5, 0xa96a, 0xb8e3, 0x8a78, 0x9bf1,
  158. 0x7387, 0x620e, 0x5095, 0x411c, 0x35a3, 0x242a, 0x16b1, 0x0738,
  159. 0xffcf, 0xee46, 0xdcdd, 0xcd54, 0xb9eb, 0xa862, 0x9af9, 0x8b70,
  160. 0x8408, 0x9581, 0xa71a, 0xb693, 0xc22c, 0xd3a5, 0xe13e, 0xf0b7,
  161. 0x0840, 0x19c9, 0x2b52, 0x3adb, 0x4e64, 0x5fed, 0x6d76, 0x7cff,
  162. 0x9489, 0x8500, 0xb79b, 0xa612, 0xd2ad, 0xc324, 0xf1bf, 0xe036,
  163. 0x18c1, 0x0948, 0x3bd3, 0x2a5a, 0x5ee5, 0x4f6c, 0x7df7, 0x6c7e,
  164. 0xa50a, 0xb483, 0x8618, 0x9791, 0xe32e, 0xf2a7, 0xc03c, 0xd1b5,
  165. 0x2942, 0x38cb, 0x0a50, 0x1bd9, 0x6f66, 0x7eef, 0x4c74, 0x5dfd,
  166. 0xb58b, 0xa402, 0x9699, 0x8710, 0xf3af, 0xe226, 0xd0bd, 0xc134,
  167. 0x39c3, 0x284a, 0x1ad1, 0x0b58, 0x7fe7, 0x6e6e, 0x5cf5, 0x4d7c,
  168. 0xc60c, 0xd785, 0xe51e, 0xf497, 0x8028, 0x91a1, 0xa33a, 0xb2b3,
  169. 0x4a44, 0x5bcd, 0x6956, 0x78df, 0x0c60, 0x1de9, 0x2f72, 0x3efb,
  170. 0xd68d, 0xc704, 0xf59f, 0xe416, 0x90a9, 0x8120, 0xb3bb, 0xa232,
  171. 0x5ac5, 0x4b4c, 0x79d7, 0x685e, 0x1ce1, 0x0d68, 0x3ff3, 0x2e7a,
  172. 0xe70e, 0xf687, 0xc41c, 0xd595, 0xa12a, 0xb0a3, 0x8238, 0x93b1,
  173. 0x6b46, 0x7acf, 0x4854, 0x59dd, 0x2d62, 0x3ceb, 0x0e70, 0x1ff9,
  174. 0xf78f, 0xe606, 0xd49d, 0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330,
  175. 0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78
  176. };
  177. #define HDLC_ZERO_SEARCH 0
  178. #define HDLC_FLAG_SEARCH 1
  179. #define HDLC_FLAG_FOUND  2
  180. #define HDLC_FRAME_FOUND 3
  181. #define HDLC_NULL 4
  182. #define HDLC_PART 5
  183. #define HDLC_FULL 6
  184. #define HDLC_FLAG_VALUE 0x7e
  185. #define MAKE_RAW_BYTE for (j=0; j<8; j++) { 
  186. bitcnt++;
  187. out_val >>= 1;
  188. if (val & 1) {
  189. s_one++;
  190. out_val |= 0x80;
  191. } else {
  192. s_one = 0;
  193. out_val &= 0x7f;
  194. }
  195. if (bitcnt==8) {
  196. if (d_cnt == dsize) return 0;
  197. dst[d_cnt++] = out_val;
  198. bitcnt = 0;
  199. }
  200. if (s_one == 5) {
  201. out_val >>= 1;
  202. out_val &= 0x7f;
  203. bitcnt++;
  204. s_one = 0;
  205. }
  206. if (bitcnt==8) {
  207. if (d_cnt == dsize) return 0;
  208. dst[d_cnt++] = out_val;
  209. bitcnt = 0;
  210. }
  211. val >>= 1;
  212. }
  213. /* Optimization suggestion: If needed, this function could be
  214.  * dramatically sped up using a state machine.  Each state would
  215.  * correspond to having seen N one bits, and being offset M bits into
  216.  * the current output byte.  N ranges from 0 to 4, M from 0 to 7, so
  217.  * we need 5*8 = 35 states.  Each state would have a table with 256
  218.  * entries, one for each input character.  Each entry would contain
  219.  * three output characters, an output state, an a byte increment
  220.  * that's either 1 or 2.  All this could fit in four bytes; so we need
  221.  * 4 bytes * 256 characters = 1 KB for each state (35 KB total).  Zero
  222.  * the output buffer before you start.  For each character in your
  223.  * input, you look it up in the current state's table and get three
  224.  * bytes to be or'ed into the output at the current byte offset, and
  225.  * an byte increment to move your pointer forward.  A simple Perl
  226.  * script could generate the tables.  Given HDLC semantics, probably
  227.  * would be better to set output to all 1s, then use ands instead of ors.
  228.  * A smaller state machine could operate on nibbles instead of bytes.
  229.  * A state machine for 32-bit architectures could use word offsets
  230.  * instead of byte offsets, requiring 5*32 = 160 states; probably
  231.  * best to work on nibbles in such a case.
  232.  */
  233. int make_raw_hdlc_data(u_char *src, u_int slen, u_char *dst, u_int dsize)
  234. {
  235. register u_int i,d_cnt=0;
  236. register u_char j;
  237. register u_char val;
  238. register u_char s_one = 0;
  239. register u_char out_val = 0;
  240. register u_char bitcnt = 0;
  241. u_int fcs;
  242. dst[d_cnt++] = HDLC_FLAG_VALUE;
  243. fcs = PPP_INITFCS;
  244. for (i=0; i<slen; i++) {
  245. val = src[i];
  246. fcs = PPP_FCS (fcs, val);
  247. MAKE_RAW_BYTE;
  248. }
  249. fcs ^= 0xffff;
  250. val = fcs & 0xff;
  251. MAKE_RAW_BYTE;
  252. val = (fcs>>8) & 0xff;
  253. MAKE_RAW_BYTE;
  254. val = HDLC_FLAG_VALUE;
  255. for (j=0; j<8; j++) { 
  256. bitcnt++;
  257. out_val >>= 1;
  258. if (val & 1)
  259. out_val |= 0x80;
  260. else
  261. out_val &= 0x7f;
  262. if (bitcnt==8) {
  263. if (d_cnt == dsize) return 0;
  264. dst[d_cnt++] = out_val;
  265. bitcnt = 0;
  266. }
  267. val >>= 1;
  268. }
  269. if (bitcnt) {
  270. while (8>bitcnt++) {
  271. out_val >>= 1;
  272. out_val |= 0x80;
  273. }
  274. if (d_cnt == dsize) return 0;
  275. dst[d_cnt++] = out_val;
  276. }
  277. return d_cnt;
  278. }
  279. void init_hdlc_state(struct hdlc_state *stateptr, int mode)
  280. {
  281. stateptr->state = HDLC_ZERO_SEARCH;
  282. stateptr->r_one = 0;
  283. stateptr->r_val = 0;
  284. stateptr->o_bitcnt = 0;
  285. stateptr->i_bitcnt = 0;
  286. stateptr->insane_mode = mode;
  287. }
  288. /* Optimization suggestion: A similar state machine could surely
  289.  * be developed for this function as well.
  290.  */
  291. int read_raw_hdlc_data(struct hdlc_state *saved_state,
  292.                        u_char *src, u_int slen, u_char *dst, u_int dsize)
  293. {
  294. int retval=0;
  295. register u_char val;
  296. register u_char state = saved_state->state;
  297. register u_char r_one = saved_state->r_one;
  298. register u_char r_val = saved_state->r_val;
  299. register u_int o_bitcnt = saved_state->o_bitcnt;
  300. register u_int i_bitcnt = saved_state->i_bitcnt;
  301. register u_int fcs    = saved_state->fcs;
  302. register u_int *isrc = (u_int *) src;
  303.         
  304. /* Use i_bitcnt (bit offset into source buffer) to reload "val"
  305.  * in case we're starting up again partway through a source buffer
  306.  */
  307. if ((i_bitcnt >> 3) < slen) {
  308. if (saved_state->insane_mode==1) {
  309. val = isrc[(i_bitcnt >> 3)] & 0xff;
  310. } else if (saved_state->insane_mode==2) {
  311. val = (isrc[i_bitcnt >> 3] >>8) & 0xff;
  312. } else {
  313. val = src[i_bitcnt >> 3];
  314. }
  315. val >>= i_bitcnt & 7;
  316. }
  317. /* One bit per loop.  Keep going until we've got something to
  318.  * report (retval != 0), or we exhaust the source buffer
  319.  */
  320. while ((retval == 0) && ((i_bitcnt >> 3) < slen)) {
  321. if ((i_bitcnt & 7) == 0) {
  322. if (saved_state->insane_mode==1) {
  323. val = isrc[(i_bitcnt >> 3)] & 0xff;
  324. } else if (saved_state->insane_mode==2) {
  325. val = (isrc[i_bitcnt >> 3] >>8) & 0xff;
  326. } else {
  327. val = src[i_bitcnt >> 3];
  328. }
  329. #ifdef DEBUGME
  330. printf("Input byte %d: 0x%2xn", i_bitcnt>>3, val);
  331. #endif
  332. if (val == 0xff) {
  333. state = HDLC_ZERO_SEARCH;
  334. o_bitcnt = 0;
  335. r_one = 0;
  336. i_bitcnt += 8;
  337. continue;
  338. }
  339. }
  340. #ifdef DEBUGME
  341. /* printf("Data bit=%d (%d/%d)n", val&1, i_bitcnt>>3, i_bitcnt&7);*/
  342. #endif
  343. if (state == HDLC_ZERO_SEARCH) {
  344. if (val & 1) {
  345. r_one++;
  346. } else {
  347. r_one=0;
  348. state= HDLC_FLAG_SEARCH;
  349. }
  350. } else if (state == HDLC_FLAG_SEARCH) { 
  351. if (val & 1) {
  352. r_one++;
  353. if (r_one>6) {
  354. state=HDLC_ZERO_SEARCH;
  355. }
  356. } else {
  357. if (r_one==6) {
  358. o_bitcnt=0;
  359. r_val=0;
  360. state=HDLC_FLAG_FOUND;
  361. }
  362. r_one=0;
  363. }
  364. } else if (state ==  HDLC_FLAG_FOUND) {
  365. if (val & 1) {
  366. r_one++;
  367. if (r_one>6) {
  368. state=HDLC_ZERO_SEARCH;
  369. } else {
  370. r_val >>= 1;
  371. r_val |= 0x80;
  372. o_bitcnt++;
  373. }
  374. } else {
  375. if (r_one==6) {
  376. o_bitcnt=0;
  377. r_val=0;
  378. r_one=0;
  379. i_bitcnt++;
  380. val >>= 1;
  381. continue;
  382. } else if (r_one!=5) {
  383. r_val >>= 1;
  384. r_val &= 0x7f;
  385. o_bitcnt++;
  386. }
  387. r_one=0;
  388. }
  389. if ((state != HDLC_ZERO_SEARCH) &&
  390. !(o_bitcnt & 7)) {
  391. #ifdef DEBUGME
  392. printf("HDLC_FRAME_FOUND at i_bitcnt:%dn",i_bitcnt);
  393. #endif
  394. state=HDLC_FRAME_FOUND;
  395. fcs = PPP_INITFCS;
  396. dst[0] = r_val;
  397. fcs = PPP_FCS (fcs, r_val);
  398. }
  399. } else if (state ==  HDLC_FRAME_FOUND) {
  400. if (val & 1) {
  401. r_one++;
  402. if (r_one>6) {
  403. state=HDLC_ZERO_SEARCH;
  404. o_bitcnt=0;
  405. } else {
  406. r_val >>= 1;
  407. r_val |= 0x80;
  408. o_bitcnt++;
  409. }
  410. } else {
  411. if (r_one==6) {
  412. r_val=0; 
  413. r_one=0;
  414. o_bitcnt++;
  415. if (o_bitcnt & 7) {
  416. /* Alignment error */
  417. #ifdef DEBUGME
  418. printf("Alignment errorn");
  419. #endif
  420. state=HDLC_FLAG_SEARCH;
  421. retval = -1;
  422. } else if (fcs==PPP_GOODFCS) {
  423. /* Valid frame */
  424. state=HDLC_FLAG_FOUND;
  425. retval = (o_bitcnt>>3)-3;
  426. } else {
  427. /* CRC error */
  428. #ifdef DEBUGME
  429. printf("CRC error; fcs was 0x%x, should have been 0x%xn", fcs, PPP_GOODFCS);
  430. #endif
  431. state=HDLC_FLAG_FOUND;
  432. retval = -1;
  433. }
  434. } else if (r_one==5) {
  435. r_one=0;
  436. i_bitcnt++;
  437. val >>= 1;
  438. continue;
  439. } else {
  440. r_val >>= 1;
  441. r_val &= 0x7f;
  442. o_bitcnt++;
  443. }
  444. r_one=0;
  445. }
  446. if ((state == HDLC_FRAME_FOUND) &&
  447. !(o_bitcnt & 7)) {
  448. if ((o_bitcnt>>3)>=dsize) {
  449. /* Buffer overflow error */
  450. #ifdef DEBUGME
  451. printf("Buffer overflow errorn");
  452. #endif
  453. r_val=0; 
  454. state=HDLC_FLAG_SEARCH;
  455. retval = -1;
  456. } else {
  457. dst[(o_bitcnt>>3)-1] = r_val;
  458. fcs = PPP_FCS (fcs, r_val);
  459. #ifdef DEBUGME
  460. printf("Output byte %d: 0x%02x; FCS 0x%04xn", (o_bitcnt>>3)-1, r_val, fcs);
  461. #endif
  462. }
  463. }
  464. }
  465. i_bitcnt ++;
  466. val >>= 1;
  467. }
  468. /* We exhausted the source buffer before anything else happened
  469.  * (retval==0).  Reset i_bitcnt in expectation of a new source
  470.  * buffer.  Other, we either had an error or a valid frame, so
  471.  * reset o_bitcnt in expectation of a new destination buffer.
  472.  */
  473. if (retval == 0) {
  474. i_bitcnt = 0;
  475. } else {
  476. o_bitcnt = 0;
  477. }
  478. saved_state->state = state;
  479. saved_state->r_one = r_one;
  480. saved_state->r_val = r_val;
  481. saved_state->fcs = fcs;
  482. saved_state->o_bitcnt = o_bitcnt;
  483. saved_state->i_bitcnt = i_bitcnt;
  484. return (retval);
  485. }
  486. #ifdef DEBUGME
  487. char buffer[1024];
  488. char obuffer[1024];
  489. main()
  490. {
  491.   int buflen=0;
  492.   int len;
  493.   struct hdlc_state hdlc_state;
  494.   while((buffer[buflen] = getc(stdin)) != EOF && buflen<1024) buflen++;
  495.   printf("buflen = %dn", buflen);
  496.   init_hdlc_state(&hdlc_state, 0);
  497.   while (len = read_raw_hdlc_data(&hdlc_state,buffer,buflen,obuffer,1024)) {
  498.     if (len == -1) printf("Error @ byte %d/bit %dn",
  499.   hdlc_state.i_bitcnt>>3, hdlc_state.i_bitcnt & 7);
  500.     else {
  501.       printf("Frame received: len %dn", len);
  502.     }
  503.   }
  504.   printf("Donen");
  505. }
  506. #endif