blob: 00b4aaa1050502acd5d849da88308fce46ced8c9 [file] [log] [blame]
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +02001#ifndef _E1_INPUT_H
2#define _E1_INPUT_H
3
4#include <stdlib.h>
5#include <netinet/in.h>
6
7#include <osmocom/core/linuxlist.h>
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +02008#include <osmocom/core/timer.h>
9#include <osmocom/core/msgb.h>
10#include <osmocom/core/select.h>
Pablo Neira Ayuso177094b2011-06-07 12:21:51 +020011#include <osmocom/abis/subchan_demux.h>
Andreas Eversberga7ff0012011-09-26 11:29:30 +020012#include <osmocom/abis/lapd.h>
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020013
14#define NUM_E1_TS 32
Jacob Erlbeck86dae842014-01-16 18:10:37 +010015#define E1INP_USE_DEFAULT (-1)
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020016
Harald Welteb5af0992020-01-12 12:59:52 +010017#define LOGPITS(e1ts, ss, level, fmt, args ...) \
18 LOGP(ss, level, "E1TS(%u:%u) " fmt, (e1ts)->line->num, (e1ts)->num, ## args)
19
20#define LOGPIL(e1l, ss, level, fmt, args ...) \
21 LOGP(ss, level, "E1L(%u) " fmt, (e1l)->num, ## args)
22
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020023enum e1inp_sign_type {
24 E1INP_SIGN_NONE,
25 E1INP_SIGN_OML,
26 E1INP_SIGN_RSL,
Harald Welte46fc7e22014-08-18 19:04:26 +020027 E1INP_SIGN_OSMO, /* IPA CCM OSMO sub-type */
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020028};
29const char *e1inp_signtype_name(enum e1inp_sign_type tp);
Arran Cudbard-Bell67b81eb2016-11-02 11:48:24 -040030extern const struct value_string e1inp_sign_type_names[5];
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020031
Harald Weltef2737fc2011-08-16 14:30:10 +020032enum e1inp_ctr {
33 E1I_CTR_HDLC_ABORT,
34 E1I_CTR_HDLC_BADFCS,
35 E1I_CTR_HDLC_OVERR,
36 E1I_CTR_ALARM,
37 E1I_CTR_REMOVED,
38};
39
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020040struct e1inp_ts;
Harald Weltefe05cf52011-09-26 23:18:41 +020041struct vty;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020042
43struct e1inp_sign_link {
44 /* list of signalling links */
45 struct llist_head list;
46
47 /* to which timeslot do we belong? */
48 struct e1inp_ts *ts;
49
50 enum e1inp_sign_type type;
51
52 /* trx for msg->trx of received msgs */
53 struct gsm_bts_trx *trx;
54
55 /* msgb queue of to-be-transmitted msgs */
56 struct llist_head tx_list;
57
58 /* SAPI and TEI on the E1 TS */
59 uint8_t sapi;
60 uint8_t tei;
61
62 union {
63 struct {
64 uint8_t channel;
65 } misdn;
66 } driver;
67};
68
69enum e1inp_ts_type {
70 E1INP_TS_TYPE_NONE,
71 E1INP_TS_TYPE_SIGN,
72 E1INP_TS_TYPE_TRAU,
Harald Weltea0108e72016-07-27 21:44:50 +020073 E1INP_TS_TYPE_RAW,
Harald Welte7a228eb2016-07-28 11:09:31 +020074 E1INP_TS_TYPE_HDLC,
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020075};
76const char *e1inp_tstype_name(enum e1inp_ts_type tp);
Arran Cudbard-Bell67b81eb2016-11-02 11:48:24 -040077extern const struct value_string e1inp_ts_type_names[6];
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020078
79/* A timeslot in the E1 interface */
80struct e1inp_ts {
81 enum e1inp_ts_type type;
82 int num;
83
84 /* to which line do we belong ? */
85 struct e1inp_line *line;
86
Harald Weltefd44a5f2011-08-21 00:48:54 +020087 /* LAPD instance, if any */
88 struct lapd_instance *lapd;
89
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +020090 union {
91 struct {
92 /* list of all signalling links on this TS */
93 struct llist_head sign_links;
94 /* delay for the queue */
95 int delay;
96 /* timer when to dequeue next frame */
97 struct osmo_timer_list tx_timer;
98 } sign;
99 struct {
100 /* subchannel demuxer for frames from E1 */
101 struct subch_demux demux;
102 /* subchannel muxer for frames to E1 */
103 struct subch_mux mux;
104 } trau;
Harald Weltea0108e72016-07-27 21:44:50 +0200105 struct {
106 /* call-back for every received frame */
107 void (*recv_cb)(struct e1inp_ts *ts, struct msgb *msg);
108 /* queue of pending to-be-transmitted msgbs */
109 struct llist_head tx_queue;
110 } raw;
Harald Welte7a228eb2016-07-28 11:09:31 +0200111 struct {
112 /* call-back for every received frame */
113 void (*recv_cb)(struct e1inp_ts *ts, struct msgb *msg);
114 /* queue of pending to-be-transmitted msgbs */
115 struct llist_head tx_queue;
116 } hdlc;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200117 };
118 union {
119 struct {
120 /* mISDN driver has one fd for each ts */
121 struct osmo_fd fd;
122 } misdn;
123 struct {
124 /* ip.access driver has one fd for each ts */
125 struct osmo_fd fd;
126 } ipaccess;
127 struct {
128 /* DAHDI driver has one fd for each ts */
129 struct osmo_fd fd;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200130 } dahdi;
Pablo Neira Ayuso7e0d0062011-08-19 11:36:15 +0200131 struct {
Sylvain Munautb559a532019-05-09 11:14:26 +0200132 /* osmo-e1d driver has one fd for each ts */
133 struct osmo_fd fd;
134 } e1d;
135 struct {
Pablo Neira Ayuso7e0d0062011-08-19 11:36:15 +0200136 struct osmo_fd fd;
137 } rs232;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200138 } driver;
Jacob Erlbeck98af3c32014-03-31 10:53:32 +0200139
140 struct msgb *pending_msg;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200141};
142
143struct gsm_e1_subslot {
144 /* Number of E1 link */
145 uint8_t e1_nr;
146 /* Number of E1 TS inside E1 link */
147 uint8_t e1_ts;
148 /* Sub-slot within the E1 TS, 0xff if full TS */
149 uint8_t e1_ts_ss;
150};
151
152enum e1inp_line_role {
153 E1INP_LINE_R_NONE,
154 E1INP_LINE_R_BSC,
155 E1INP_LINE_R_BTS,
156 E1INP_LINE_R_MAX
157};
158
159struct e1inp_driver {
160 struct llist_head list;
161 const char *name;
162 int (*want_write)(struct e1inp_ts *ts);
Pablo Neira Ayuso4e862cb2011-08-19 18:43:38 +0200163 int (*line_update)(struct e1inp_line *line);
Pablo Neira Ayusoadd3ec82011-07-05 14:45:46 +0200164 void (*close)(struct e1inp_sign_link *link);
Harald Weltefe05cf52011-09-26 23:18:41 +0200165 void (*vty_show)(struct vty *vty, struct e1inp_line *line);
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200166 int default_delay;
Jacob Erlbeck86dae842014-01-16 18:10:37 +0100167 int has_keepalive;
Neels Hofmeyr0db1d432016-02-22 13:29:09 +0100168 const char *bind_addr;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200169};
170
Pablo Neira Ayuso5a4b7c52011-06-07 14:07:48 +0200171struct e1inp_line_ops {
Pablo Neira Ayuso4e862cb2011-08-19 18:43:38 +0200172 union {
173 struct {
174 enum e1inp_line_role role; /* BSC or BTS mode. */
175 const char *addr; /* IP address .*/
176 void *dev; /* device parameters. */
177 } ipa;
178 struct {
179 const char *port; /* e.g. /dev/ttyUSB0 */
180 unsigned int delay;
181 } rs232;
182 } cfg;
Pablo Neira Ayusof163d232011-06-25 18:42:55 +0200183
Pablo Neira Ayusoc9c4fd32011-06-30 12:19:42 +0200184 struct e1inp_sign_link * (*sign_link_up)(void *unit_info, struct e1inp_line *line, enum e1inp_sign_type type);
185 void (*sign_link_down)(struct e1inp_line *line);
Pau Espin Pedroled122f32018-08-28 18:25:02 +0200186 /* Called when a new message arrives. -EBADF must be returned if the osmo_fd in link (msg->dst) is destroyed. */
Pablo Neira Ayusodbd82fb2011-07-05 15:29:23 +0200187 int (*sign_link)(struct msgb *msg);
Pablo Neira Ayuso5a4b7c52011-06-07 14:07:48 +0200188};
189
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200190struct e1inp_line {
191 struct llist_head list;
192 int refcnt;
193
194 unsigned int num;
195 const char *name;
Harald Weltec2889512011-09-13 23:49:04 +0100196 unsigned int port_nr;
Alexander Couzensbeb10ef2016-11-01 22:05:13 +0100197 char *sock_path;
Harald Weltef2737fc2011-08-16 14:30:10 +0200198 struct rate_ctr_group *rate_ctr;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200199
Jacob Erlbeck86dae842014-01-16 18:10:37 +0100200 /* keepalive configuration */
201 int keepalive_num_probes; /* 0: disable, num, or E1INP_USE_DEFAULT */
202 int keepalive_idle_timeout; /* secs, or E1INP_USE_DEFAULT */
203 int keepalive_probe_interval; /* secs or E1INP_USE_DEFAULT */
204
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200205 /* array of timestlots */
206 struct e1inp_ts ts[NUM_E1_TS];
Harald Weltec2889512011-09-13 23:49:04 +0100207 unsigned int num_ts;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200208
Pablo Neira Ayusof163d232011-06-25 18:42:55 +0200209 const struct e1inp_line_ops *ops;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200210
211 struct e1inp_driver *driver;
212 void *driver_data;
213};
Pau Espin Pedrolb5cfc6b2018-10-02 21:22:18 +0200214#define e1inp_line_ipa_oml_ts(line) (&line->ts[0])
215#define e1inp_line_ipa_rsl_ts(line, trx_id) (&line->ts[1 + (trx_id)])
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200216
Harald Weltecc2241b2011-07-19 16:06:06 +0200217/* SS_L_INPUT signals */
Pablo Neira Ayuso332a3572011-08-16 17:31:20 +0200218enum e1inp_signal_input {
Pablo Neira Ayusode668912011-08-16 17:26:23 +0200219 S_L_INP_NONE,
220 S_L_INP_TEI_UP,
221 S_L_INP_TEI_DN,
222 S_L_INP_TEI_UNKNOWN,
223 S_L_INP_LINE_INIT,
224 S_L_INP_LINE_ALARM,
225 S_L_INP_LINE_NOALARM,
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200226};
227
Harald Weltecac78fe2017-05-25 19:13:13 +0200228extern const struct value_string e1inp_signal_names[];
229
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200230/* register a driver with the E1 core */
231int e1inp_driver_register(struct e1inp_driver *drv);
232
233/* fine a previously registered driver */
234struct e1inp_driver *e1inp_driver_find(const char *name);
235
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200236/* get a line by its ID */
Pablo Neira Ayuso3832c4f2011-07-07 17:47:26 +0200237struct e1inp_line *e1inp_line_find(uint8_t e1_nr);
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200238
239/* create a line in the E1 input core */
Pablo Neira Ayusof163d232011-06-25 18:42:55 +0200240struct e1inp_line *e1inp_line_create(uint8_t e1_nr, const char *driver_name);
241
Pablo Neira Ayuso3832c4f2011-07-07 17:47:26 +0200242/* clone one existing E1 input line */
243struct e1inp_line *e1inp_line_clone(void *ctx, struct e1inp_line *line);
244
245/* increment refcount use of E1 input line */
246void e1inp_line_get(struct e1inp_line *line);
247
248/* decrement refcount use of E1 input line, release if unused */
249void e1inp_line_put(struct e1inp_line *line);
250
Pablo Neira Ayusof163d232011-06-25 18:42:55 +0200251/* bind operations to one E1 input line */
252void e1inp_line_bind_ops(struct e1inp_line *line, const struct e1inp_line_ops *ops);
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200253
254/* find a sign_link for given TEI and SAPI in a TS */
255struct e1inp_sign_link *
256e1inp_lookup_sign_link(struct e1inp_ts *ts, uint8_t tei,
257 uint8_t sapi);
258
259/* create a new signalling link in a E1 timeslot */
260struct e1inp_sign_link *
261e1inp_sign_link_create(struct e1inp_ts *ts, enum e1inp_sign_type type,
262 struct gsm_bts_trx *trx, uint8_t tei,
263 uint8_t sapi);
264
Pablo Neira Ayuso211d2ca2011-06-07 17:15:10 +0200265/* configure and initialize one signalling e1inp_ts */
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200266int e1inp_ts_config_sign(struct e1inp_ts *ts, struct e1inp_line *line);
Pablo Neira Ayuso211d2ca2011-06-07 17:15:10 +0200267
268/* configure and initialize one timeslot dedicated to TRAU frames. */
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200269int e1inp_ts_config_trau(struct e1inp_ts *ts, struct e1inp_line *line,
Pablo Neira Ayuso211d2ca2011-06-07 17:15:10 +0200270 int (*trau_rcv_cb)(struct subch_demux *dmx, int ch,
271 uint8_t *data, int len, void *_priv));
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200272
Harald Weltea0108e72016-07-27 21:44:50 +0200273/* configure and initialize one timeslot dedicated to RAW frames */
274int e1inp_ts_config_raw(struct e1inp_ts *ts, struct e1inp_line *line,
275 void (*raw_recv_cb)(struct e1inp_ts *ts,
276 struct msgb *msg));
277
Harald Welte7a228eb2016-07-28 11:09:31 +0200278/* configure and initialize one timeslot dedicated to HDLC frames */
279int e1inp_ts_config_hdlc(struct e1inp_ts *ts, struct e1inp_line *line,
280 void (*hdlc_recv_cb)(struct e1inp_ts *ts,
281 struct msgb *msg));
282
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200283/* Receive a packet from the E1 driver */
284int e1inp_rx_ts(struct e1inp_ts *ts, struct msgb *msg,
285 uint8_t tei, uint8_t sapi);
Harald Weltefd44a5f2011-08-21 00:48:54 +0200286int e1inp_rx_ts_lapd(struct e1inp_ts *e1i_ts, struct msgb *msg);
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200287
288/* called by driver if it wants to transmit on a given TS */
289struct msgb *e1inp_tx_ts(struct e1inp_ts *e1i_ts,
290 struct e1inp_sign_link **sign_link);
291
292/* called by driver in case some kind of link state event */
293int e1inp_event(struct e1inp_ts *ts, int evt, uint8_t tei, uint8_t sapi);
294
Andreas Eversberga7ff0012011-09-26 11:29:30 +0200295/* L2->L3 */
296void e1inp_dlsap_up(struct osmo_dlsap_prim *odp, uint8_t tei, uint8_t sapi,
297 void *rx_cbdata);
298
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200299/* Write LAPD frames to the fd. */
Pablo Neira Ayuso2e11f5c2013-07-05 15:08:18 +0200300int e1_set_pcap_fd(int fd);
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200301
302/* called by TRAU muxer to obtain the destination mux entity */
303struct subch_mux *e1inp_get_mux(uint8_t e1_nr, uint8_t ts_nr);
304
Harald Welte84f67b22013-06-30 13:13:59 +0200305/* on an IPA BTS, the BTS needs to establish the RSL connection much
306 * later than the OML connection. */
307int e1inp_ipa_bts_rsl_connect(struct e1inp_line *line,
308 const char *rem_addr, uint16_t rem_port);
309
Andreas Eversbergf422a752014-01-21 14:54:41 +0100310int e1inp_ipa_bts_rsl_connect_n(struct e1inp_line *line,
311 const char *rem_addr, uint16_t rem_port,
312 uint8_t trx_id);
313
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200314void e1inp_sign_link_destroy(struct e1inp_sign_link *link);
Pablo Neira Ayusof163d232011-06-25 18:42:55 +0200315int e1inp_line_update(struct e1inp_line *line);
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200316
Pablo Neira Ayuso262aee82011-07-05 19:17:08 +0200317int e1inp_vty_init(void);
318
Alexander Couzensbeb10ef2016-11-01 22:05:13 +0100319/* activate superchannel or deactive to use timeslots. only valid for unixsocket driver */
320void e1inp_ericsson_set_altc(struct e1inp_line *unixlinue, int superchannel);
321
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200322extern struct llist_head e1inp_driver_list;
323extern struct llist_head e1inp_line_list;
324
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200325/* XXX */
326struct input_signal_data {
Pau Espin Pedrol41792072018-10-03 13:18:37 +0200327 enum e1inp_sign_type link_type;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200328 uint8_t tei;
329 uint8_t sapi;
Harald Weltef35d8892016-10-16 15:33:52 +0200330 uint8_t ts_nr;
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200331 struct gsm_bts_trx *trx;
332 struct e1inp_line *line;
333};
334
Pablo Neira Ayuso96e72632011-06-26 19:08:05 +0200335int abis_sendmsg(struct msgb *msg);
Holger Hans Peter Freyther180ce7e2012-02-03 20:06:15 +0100336int abis_rsl_sendmsg(struct msgb *msg);
Pablo Neira Ayuso96e72632011-06-26 19:08:05 +0200337
Pablo Neira Ayuso0ba77d52011-06-05 18:32:44 +0200338#endif /* _E1_INPUT_H */