1 /* $Id: capiutil.h,v 1.5.6.2 2001/09/23 22:24:33 kai Exp $
3 * CAPI 2.0 defines & types
5 * From CAPI 2.0 Development Kit AVM 1995 (msg.c)
6 * Rewritten for Linux 1996 by Carsten Paeth <calle@calle.de>
8 * This software may be used and distributed according to the terms
9 * of the GNU General Public License, incorporated herein by reference.
13 #ifndef __CAPIUTIL_H__
14 #define __CAPIUTIL_H__
16 #include <asm/types.h>
18 #define CAPIMSG_BASELEN 8
19 #define CAPIMSG_U8(m, off) (m[off])
20 #define CAPIMSG_U16(m, off) (m[off]|(m[(off)+1]<<8))
21 #define CAPIMSG_U32(m, off) (m[off]|(m[(off)+1]<<8)|(m[(off)+2]<<16)|(m[(off)+3]<<24))
22 #define CAPIMSG_LEN(m) CAPIMSG_U16(m,0)
23 #define CAPIMSG_APPID(m) CAPIMSG_U16(m,2)
24 #define CAPIMSG_COMMAND(m) CAPIMSG_U8(m,4)
25 #define CAPIMSG_SUBCOMMAND(m) CAPIMSG_U8(m,5)
26 #define CAPIMSG_CMD(m) (((m[4])<<8)|(m[5]))
27 #define CAPIMSG_MSGID(m) CAPIMSG_U16(m,6)
28 #define CAPIMSG_CONTROLLER(m) (m[8] & 0x7f)
29 #define CAPIMSG_CONTROL(m) CAPIMSG_U32(m, 8)
30 #define CAPIMSG_NCCI(m) CAPIMSG_CONTROL(m)
31 #define CAPIMSG_DATALEN(m) CAPIMSG_U16(m,16) /* DATA_B3_REQ */
33 static inline void capimsg_setu8(void *m, int off, __u8 val)
35 ((__u8 *)m)[off] = val;
38 static inline void capimsg_setu16(void *m, int off, __u16 val)
40 ((__u8 *)m)[off] = val & 0xff;
41 ((__u8 *)m)[off+1] = (val >> 8) & 0xff;
44 static inline void capimsg_setu32(void *m, int off, __u32 val)
46 ((__u8 *)m)[off] = val & 0xff;
47 ((__u8 *)m)[off+1] = (val >> 8) & 0xff;
48 ((__u8 *)m)[off+2] = (val >> 16) & 0xff;
49 ((__u8 *)m)[off+3] = (val >> 24) & 0xff;
52 #define CAPIMSG_SETLEN(m, len) capimsg_setu16(m, 0, len)
53 #define CAPIMSG_SETAPPID(m, applid) capimsg_setu16(m, 2, applid)
54 #define CAPIMSG_SETCOMMAND(m,cmd) capimsg_setu8(m, 4, cmd)
55 #define CAPIMSG_SETSUBCOMMAND(m, cmd) capimsg_setu8(m, 5, cmd)
56 #define CAPIMSG_SETMSGID(m, msgid) capimsg_setu16(m, 6, msgid)
57 #define CAPIMSG_SETCONTROL(m, contr) capimsg_setu32(m, 8, contr)
58 #define CAPIMSG_SETDATALEN(m, len) capimsg_setu16(m, 16, len)
60 /*----- basic-type definitions -----*/
62 typedef __u8 *_cstruct;
70 The _cmsg structure contains all possible CAPI 2.0 parameter.
71 All parameters are stored here first. The function CAPI_CMSG_2_MESSAGE
72 assembles the parameter and builds CAPI2.0 conform messages.
73 CAPI_MESSAGE_2_CMSG disassembles CAPI 2.0 messages and stores the
74 parameter in the _cmsg structure
91 _cmstruct AdditionalInfo;
92 _cstruct B1configuration;
94 _cstruct B2configuration;
96 _cstruct B3configuration;
99 _cstruct BChannelinformation;
101 _cstruct CalledPartyNumber;
102 _cstruct CalledPartySubaddress;
103 _cstruct CallingPartyNumber;
104 _cstruct CallingPartySubaddress;
109 _cstruct ConnectedNumber;
110 _cstruct ConnectedSubaddress;
114 _cstruct FacilityConfirmationParameter;
115 _cstruct Facilitydataarray;
116 _cstruct FacilityIndicationParameter;
117 _cstruct FacilityRequestParameter;
118 __u16 FacilitySelector;
123 _cstruct InfoElement;
126 _cstruct Keypadfacility;
134 _cstruct Useruserdata;
141 /* buffer to construct message */
147 * capi_cmsg2message() assembles the parameter from _cmsg to a CAPI 2.0
150 unsigned capi_cmsg2message(_cmsg * cmsg, __u8 * msg);
153 * capi_message2cmsg disassembles a CAPI message an writes the parameter
154 * into _cmsg for easy access
156 unsigned capi_message2cmsg(_cmsg * cmsg, __u8 * msg);
159 * capi_cmsg_header() fills the _cmsg structure with default values, so only
160 * parameter with non default values must be changed before sending the
163 unsigned capi_cmsg_header(_cmsg * cmsg, __u16 _ApplId,
164 __u8 _Command, __u8 _Subcommand,
165 __u16 _Messagenumber, __u32 _Controller);
168 * capi_info2str generated a readable string for Capi2.0 reasons.
170 char *capi_info2str(__u16 reason);
172 /*-----------------------------------------------------------------------*/
175 * Debugging / Tracing functions
178 char *capi_cmd2str(__u8 cmd, __u8 subcmd);
187 #define CDEBUG_SIZE 1024
188 #define CDEBUG_GSIZE 4096
190 _cdebbuf *cdebbuf_alloc(void);
191 void cdebbuf_free(_cdebbuf *cdb);
192 int cdebug_init(void);
193 void cdebug_exit(void);
195 _cdebbuf *capi_cmsg2str(_cmsg *cmsg);
196 _cdebbuf *capi_message2str(__u8 *msg);
198 /*-----------------------------------------------------------------------*/
200 static inline void capi_cmsg_answer(_cmsg * cmsg)
202 cmsg->Subcommand |= 0x01;
205 /*-----------------------------------------------------------------------*/
207 static inline void capi_fill_CONNECT_B3_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
211 capi_cmsg_header(cmsg, ApplId, 0x82, 0x80, Messagenumber, adr);
215 static inline void capi_fill_FACILITY_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
217 __u16 FacilitySelector,
218 _cstruct FacilityRequestParameter)
220 capi_cmsg_header(cmsg, ApplId, 0x80, 0x80, Messagenumber, adr);
221 cmsg->FacilitySelector = FacilitySelector;
222 cmsg->FacilityRequestParameter = FacilityRequestParameter;
225 static inline void capi_fill_INFO_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
227 _cstruct CalledPartyNumber,
228 _cstruct BChannelinformation,
229 _cstruct Keypadfacility,
230 _cstruct Useruserdata,
231 _cstruct Facilitydataarray)
233 capi_cmsg_header(cmsg, ApplId, 0x08, 0x80, Messagenumber, adr);
234 cmsg->CalledPartyNumber = CalledPartyNumber;
235 cmsg->BChannelinformation = BChannelinformation;
236 cmsg->Keypadfacility = Keypadfacility;
237 cmsg->Useruserdata = Useruserdata;
238 cmsg->Facilitydataarray = Facilitydataarray;
241 static inline void capi_fill_LISTEN_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
246 _cstruct CallingPartyNumber,
247 _cstruct CallingPartySubaddress)
249 capi_cmsg_header(cmsg, ApplId, 0x05, 0x80, Messagenumber, adr);
250 cmsg->InfoMask = InfoMask;
251 cmsg->CIPmask = CIPmask;
252 cmsg->CIPmask2 = CIPmask2;
253 cmsg->CallingPartyNumber = CallingPartyNumber;
254 cmsg->CallingPartySubaddress = CallingPartySubaddress;
257 static inline void capi_fill_ALERT_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
259 _cstruct BChannelinformation,
260 _cstruct Keypadfacility,
261 _cstruct Useruserdata,
262 _cstruct Facilitydataarray)
264 capi_cmsg_header(cmsg, ApplId, 0x01, 0x80, Messagenumber, adr);
265 cmsg->BChannelinformation = BChannelinformation;
266 cmsg->Keypadfacility = Keypadfacility;
267 cmsg->Useruserdata = Useruserdata;
268 cmsg->Facilitydataarray = Facilitydataarray;
271 static inline void capi_fill_CONNECT_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
274 _cstruct CalledPartyNumber,
275 _cstruct CallingPartyNumber,
276 _cstruct CalledPartySubaddress,
277 _cstruct CallingPartySubaddress,
281 _cstruct B1configuration,
282 _cstruct B2configuration,
283 _cstruct B3configuration,
287 _cstruct BChannelinformation,
288 _cstruct Keypadfacility,
289 _cstruct Useruserdata,
290 _cstruct Facilitydataarray)
293 capi_cmsg_header(cmsg, ApplId, 0x02, 0x80, Messagenumber, adr);
294 cmsg->CIPValue = CIPValue;
295 cmsg->CalledPartyNumber = CalledPartyNumber;
296 cmsg->CallingPartyNumber = CallingPartyNumber;
297 cmsg->CalledPartySubaddress = CalledPartySubaddress;
298 cmsg->CallingPartySubaddress = CallingPartySubaddress;
299 cmsg->B1protocol = B1protocol;
300 cmsg->B2protocol = B2protocol;
301 cmsg->B3protocol = B3protocol;
302 cmsg->B1configuration = B1configuration;
303 cmsg->B2configuration = B2configuration;
304 cmsg->B3configuration = B3configuration;
308 cmsg->BChannelinformation = BChannelinformation;
309 cmsg->Keypadfacility = Keypadfacility;
310 cmsg->Useruserdata = Useruserdata;
311 cmsg->Facilitydataarray = Facilitydataarray;
314 static inline void capi_fill_DATA_B3_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
322 capi_cmsg_header(cmsg, ApplId, 0x86, 0x80, Messagenumber, adr);
324 cmsg->DataLength = DataLength;
325 cmsg->DataHandle = DataHandle;
329 static inline void capi_fill_DISCONNECT_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
331 _cstruct BChannelinformation,
332 _cstruct Keypadfacility,
333 _cstruct Useruserdata,
334 _cstruct Facilitydataarray)
337 capi_cmsg_header(cmsg, ApplId, 0x04, 0x80, Messagenumber, adr);
338 cmsg->BChannelinformation = BChannelinformation;
339 cmsg->Keypadfacility = Keypadfacility;
340 cmsg->Useruserdata = Useruserdata;
341 cmsg->Facilitydataarray = Facilitydataarray;
344 static inline void capi_fill_DISCONNECT_B3_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
349 capi_cmsg_header(cmsg, ApplId, 0x84, 0x80, Messagenumber, adr);
353 static inline void capi_fill_MANUFACTURER_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
361 capi_cmsg_header(cmsg, ApplId, 0xff, 0x80, Messagenumber, adr);
362 cmsg->ManuID = ManuID;
364 cmsg->Function = Function;
365 cmsg->ManuData = ManuData;
368 static inline void capi_fill_RESET_B3_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
373 capi_cmsg_header(cmsg, ApplId, 0x87, 0x80, Messagenumber, adr);
377 static inline void capi_fill_SELECT_B_PROTOCOL_REQ(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
382 _cstruct B1configuration,
383 _cstruct B2configuration,
384 _cstruct B3configuration)
387 capi_cmsg_header(cmsg, ApplId, 0x41, 0x80, Messagenumber, adr);
388 cmsg->B1protocol = B1protocol;
389 cmsg->B2protocol = B2protocol;
390 cmsg->B3protocol = B3protocol;
391 cmsg->B1configuration = B1configuration;
392 cmsg->B2configuration = B2configuration;
393 cmsg->B3configuration = B3configuration;
396 static inline void capi_fill_CONNECT_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
402 _cstruct B1configuration,
403 _cstruct B2configuration,
404 _cstruct B3configuration,
405 _cstruct ConnectedNumber,
406 _cstruct ConnectedSubaddress,
408 _cstruct BChannelinformation,
409 _cstruct Keypadfacility,
410 _cstruct Useruserdata,
411 _cstruct Facilitydataarray)
413 capi_cmsg_header(cmsg, ApplId, 0x02, 0x83, Messagenumber, adr);
414 cmsg->Reject = Reject;
415 cmsg->B1protocol = B1protocol;
416 cmsg->B2protocol = B2protocol;
417 cmsg->B3protocol = B3protocol;
418 cmsg->B1configuration = B1configuration;
419 cmsg->B2configuration = B2configuration;
420 cmsg->B3configuration = B3configuration;
421 cmsg->ConnectedNumber = ConnectedNumber;
422 cmsg->ConnectedSubaddress = ConnectedSubaddress;
424 cmsg->BChannelinformation = BChannelinformation;
425 cmsg->Keypadfacility = Keypadfacility;
426 cmsg->Useruserdata = Useruserdata;
427 cmsg->Facilitydataarray = Facilitydataarray;
430 static inline void capi_fill_CONNECT_ACTIVE_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
434 capi_cmsg_header(cmsg, ApplId, 0x03, 0x83, Messagenumber, adr);
437 static inline void capi_fill_CONNECT_B3_ACTIVE_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
441 capi_cmsg_header(cmsg, ApplId, 0x83, 0x83, Messagenumber, adr);
444 static inline void capi_fill_CONNECT_B3_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
449 capi_cmsg_header(cmsg, ApplId, 0x82, 0x83, Messagenumber, adr);
450 cmsg->Reject = Reject;
454 static inline void capi_fill_CONNECT_B3_T90_ACTIVE_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
458 capi_cmsg_header(cmsg, ApplId, 0x88, 0x83, Messagenumber, adr);
461 static inline void capi_fill_DATA_B3_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
466 capi_cmsg_header(cmsg, ApplId, 0x86, 0x83, Messagenumber, adr);
467 cmsg->DataHandle = DataHandle;
470 static inline void capi_fill_DISCONNECT_B3_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
474 capi_cmsg_header(cmsg, ApplId, 0x84, 0x83, Messagenumber, adr);
477 static inline void capi_fill_DISCONNECT_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
481 capi_cmsg_header(cmsg, ApplId, 0x04, 0x83, Messagenumber, adr);
484 static inline void capi_fill_FACILITY_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
486 __u16 FacilitySelector)
489 capi_cmsg_header(cmsg, ApplId, 0x80, 0x83, Messagenumber, adr);
490 cmsg->FacilitySelector = FacilitySelector;
493 static inline void capi_fill_INFO_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
497 capi_cmsg_header(cmsg, ApplId, 0x08, 0x83, Messagenumber, adr);
500 static inline void capi_fill_MANUFACTURER_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
508 capi_cmsg_header(cmsg, ApplId, 0xff, 0x83, Messagenumber, adr);
509 cmsg->ManuID = ManuID;
511 cmsg->Function = Function;
512 cmsg->ManuData = ManuData;
515 static inline void capi_fill_RESET_B3_RESP(_cmsg * cmsg, __u16 ApplId, __u16 Messagenumber,
519 capi_cmsg_header(cmsg, ApplId, 0x87, 0x83, Messagenumber, adr);
522 #endif /* __CAPIUTIL_H__ */