Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 1 | /* |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 2 | * isdnhdlc.h -- General purpose ISDN HDLC decoder. |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 3 | * |
| 4 | * Implementation of a HDLC decoder/encoder in software. |
| 5 | * Necessary because some ISDN devices don't have HDLC |
| 6 | * controllers. |
| 7 | * |
| 8 | * Copyright (C) |
| 9 | * 2009 Karsten Keil <keil@b1-systems.de> |
| 10 | * 2002 Wolfgang Mües <wolfgang@iksw-muees.de> |
| 11 | * 2001 Frode Isaksen <fisaksen@bewan.com> |
| 12 | * 2001 Kai Germaschewski <kai.germaschewski@gmx.de> |
| 13 | * |
| 14 | * This program is free software; you can redistribute it and/or modify |
| 15 | * it under the terms of the GNU General Public License as published by |
| 16 | * the Free Software Foundation; either version 2 of the License, or |
| 17 | * (at your option) any later version. |
| 18 | * |
| 19 | * This program is distributed in the hope that it will be useful, |
| 20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 22 | * GNU General Public License for more details. |
| 23 | * |
| 24 | * You should have received a copy of the GNU General Public License |
| 25 | * along with this program; if not, write to the Free Software |
| 26 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 27 | */ |
| 28 | |
| 29 | #ifndef __ISDNHDLC_H__ |
| 30 | #define __ISDNHDLC_H__ |
| 31 | |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 32 | #include <stdint.h> |
| 33 | |
| 34 | struct osmo_isdnhdlc_vars { |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 35 | int bit_shift; |
| 36 | int hdlc_bits1; |
| 37 | int data_bits; |
| 38 | int ffbit_shift; /* encoding only */ |
| 39 | int state; |
| 40 | int dstpos; |
| 41 | |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 42 | uint16_t crc; |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 43 | |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 44 | uint8_t cbin; |
| 45 | uint8_t shift_reg; |
| 46 | uint8_t ffvalue; |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 47 | |
| 48 | /* set if transferring data */ |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 49 | uint32_t data_received:1; |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 50 | /* set if D channel (send idle instead of flags) */ |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 51 | uint32_t dchannel:1; |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 52 | /* set if 56K adaptation */ |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 53 | uint32_t do_adapt56:1; |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 54 | /* set if in closing phase (need to send CRC + flag) */ |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 55 | uint32_t do_closing:1; |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 56 | /* set if data is bitreverse */ |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 57 | uint32_t do_bitreverse:1; |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 58 | }; |
| 59 | |
| 60 | /* Feature Flags */ |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 61 | #define OSMO_HDLC_F_56KBIT 0x01 |
| 62 | #define OSMO_HDLC_F_DCHANNEL 0x02 |
| 63 | #define OSMO_HDLC_F_BITREVERSE 0x04 |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 64 | |
| 65 | /* |
| 66 | The return value from isdnhdlc_decode is |
| 67 | the frame length, 0 if no complete frame was decoded, |
| 68 | or a negative error number |
| 69 | */ |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 70 | #define OSMO_HDLC_FRAMING_ERROR 1 |
| 71 | #define OSMO_HDLC_CRC_ERROR 2 |
| 72 | #define OSMO_HDLC_LENGTH_ERROR 3 |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 73 | |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 74 | extern void osmo_isdnhdlc_rcv_init(struct osmo_isdnhdlc_vars *hdlc, uint32_t features); |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 75 | |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 76 | extern int osmo_isdnhdlc_decode(struct osmo_isdnhdlc_vars *hdlc, const uint8_t *src, |
| 77 | int slen, int *count, uint8_t *dst, int dsize); |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 78 | |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 79 | extern void osmo_isdnhdlc_out_init(struct osmo_isdnhdlc_vars *hdlc, uint32_t features); |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 80 | |
Harald Welte | 9da77ab | 2018-05-11 17:39:21 +0200 | [diff] [blame] | 81 | extern int osmo_isdnhdlc_encode(struct osmo_isdnhdlc_vars *hdlc, const uint8_t *src, |
| 82 | uint16_t slen, int *count, uint8_t *dst, int dsize); |
Harald Welte | 85b9fba | 2018-05-11 17:36:13 +0200 | [diff] [blame] | 83 | |
| 84 | #endif /* __ISDNHDLC_H__ */ |