thinkpad-acpi: name event constants
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / include / linux / mISDNif.h
blob45100b39a7cfe6bb8a621f110e7231dd9310aea5
1 /*
3 * Author Karsten Keil <kkeil@novell.com>
5 * Copyright 2008 by Karsten Keil <kkeil@novell.com>
7 * This code is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU LESSER GENERAL PUBLIC LICENSE
9 * version 2.1 as published by the Free Software Foundation.
11 * This code is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU LESSER GENERAL PUBLIC LICENSE for more details.
18 #ifndef mISDNIF_H
19 #define mISDNIF_H
21 #include <stdarg.h>
22 #include <linux/types.h>
23 #include <linux/errno.h>
24 #include <linux/socket.h>
27 * ABI Version 32 bit
29 * <8 bit> Major version
30 * - changed if any interface become backwards incompatible
32 * <8 bit> Minor version
33 * - changed if any interface is extended but backwards compatible
35 * <16 bit> Release number
36 * - should be incremented on every checkin
38 #define MISDN_MAJOR_VERSION 1
39 #define MISDN_MINOR_VERSION 1
40 #define MISDN_RELEASE 20
42 /* primitives for information exchange
43 * generell format
44 * <16 bit 0 >
45 * <8 bit command>
46 * BIT 8 = 1 LAYER private
47 * BIT 7 = 1 answer
48 * BIT 6 = 1 DATA
49 * <8 bit target layer mask>
51 * Layer = 00 is reserved for general commands
52 Layer = 01 L2 -> HW
53 Layer = 02 HW -> L2
54 Layer = 04 L3 -> L2
55 Layer = 08 L2 -> L3
56 * Layer = FF is reserved for broadcast commands
59 #define MISDN_CMDMASK 0xff00
60 #define MISDN_LAYERMASK 0x00ff
62 /* generell commands */
63 #define OPEN_CHANNEL 0x0100
64 #define CLOSE_CHANNEL 0x0200
65 #define CONTROL_CHANNEL 0x0300
66 #define CHECK_DATA 0x0400
68 /* layer 2 -> layer 1 */
69 #define PH_ACTIVATE_REQ 0x0101
70 #define PH_DEACTIVATE_REQ 0x0201
71 #define PH_DATA_REQ 0x2001
72 #define MPH_ACTIVATE_REQ 0x0501
73 #define MPH_DEACTIVATE_REQ 0x0601
74 #define MPH_INFORMATION_REQ 0x0701
75 #define PH_CONTROL_REQ 0x0801
77 /* layer 1 -> layer 2 */
78 #define PH_ACTIVATE_IND 0x0102
79 #define PH_ACTIVATE_CNF 0x4102
80 #define PH_DEACTIVATE_IND 0x0202
81 #define PH_DEACTIVATE_CNF 0x4202
82 #define PH_DATA_IND 0x2002
83 #define PH_DATA_E_IND 0x3002
84 #define MPH_ACTIVATE_IND 0x0502
85 #define MPH_DEACTIVATE_IND 0x0602
86 #define MPH_INFORMATION_IND 0x0702
87 #define PH_DATA_CNF 0x6002
88 #define PH_CONTROL_IND 0x0802
89 #define PH_CONTROL_CNF 0x4802
91 /* layer 3 -> layer 2 */
92 #define DL_ESTABLISH_REQ 0x1004
93 #define DL_RELEASE_REQ 0x1104
94 #define DL_DATA_REQ 0x3004
95 #define DL_UNITDATA_REQ 0x3104
96 #define DL_INFORMATION_REQ 0x0004
98 /* layer 2 -> layer 3 */
99 #define DL_ESTABLISH_IND 0x1008
100 #define DL_ESTABLISH_CNF 0x5008
101 #define DL_RELEASE_IND 0x1108
102 #define DL_RELEASE_CNF 0x5108
103 #define DL_DATA_IND 0x3008
104 #define DL_UNITDATA_IND 0x3108
105 #define DL_INFORMATION_IND 0x0008
107 /* intern layer 2 managment */
108 #define MDL_ASSIGN_REQ 0x1804
109 #define MDL_ASSIGN_IND 0x1904
110 #define MDL_REMOVE_REQ 0x1A04
111 #define MDL_REMOVE_IND 0x1B04
112 #define MDL_STATUS_UP_IND 0x1C04
113 #define MDL_STATUS_DOWN_IND 0x1D04
114 #define MDL_STATUS_UI_IND 0x1E04
115 #define MDL_ERROR_IND 0x1F04
116 #define MDL_ERROR_RSP 0x5F04
118 /* DL_INFORMATION_IND types */
119 #define DL_INFO_L2_CONNECT 0x0001
120 #define DL_INFO_L2_REMOVED 0x0002
122 /* PH_CONTROL types */
123 /* TOUCH TONE IS 0x20XX XX "0"..."9", "A","B","C","D","*","#" */
124 #define DTMF_TONE_VAL 0x2000
125 #define DTMF_TONE_MASK 0x007F
126 #define DTMF_TONE_START 0x2100
127 #define DTMF_TONE_STOP 0x2200
128 #define DTMF_HFC_COEF 0x4000
129 #define DSP_CONF_JOIN 0x2403
130 #define DSP_CONF_SPLIT 0x2404
131 #define DSP_RECEIVE_OFF 0x2405
132 #define DSP_RECEIVE_ON 0x2406
133 #define DSP_ECHO_ON 0x2407
134 #define DSP_ECHO_OFF 0x2408
135 #define DSP_MIX_ON 0x2409
136 #define DSP_MIX_OFF 0x240a
137 #define DSP_DELAY 0x240b
138 #define DSP_JITTER 0x240c
139 #define DSP_TXDATA_ON 0x240d
140 #define DSP_TXDATA_OFF 0x240e
141 #define DSP_TX_DEJITTER 0x240f
142 #define DSP_TX_DEJ_OFF 0x2410
143 #define DSP_TONE_PATT_ON 0x2411
144 #define DSP_TONE_PATT_OFF 0x2412
145 #define DSP_VOL_CHANGE_TX 0x2413
146 #define DSP_VOL_CHANGE_RX 0x2414
147 #define DSP_BF_ENABLE_KEY 0x2415
148 #define DSP_BF_DISABLE 0x2416
149 #define DSP_BF_ACCEPT 0x2416
150 #define DSP_BF_REJECT 0x2417
151 #define DSP_PIPELINE_CFG 0x2418
152 #define HFC_VOL_CHANGE_TX 0x2601
153 #define HFC_VOL_CHANGE_RX 0x2602
154 #define HFC_SPL_LOOP_ON 0x2603
155 #define HFC_SPL_LOOP_OFF 0x2604
157 /* DSP_TONE_PATT_ON parameter */
158 #define TONE_OFF 0x0000
159 #define TONE_GERMAN_DIALTONE 0x0001
160 #define TONE_GERMAN_OLDDIALTONE 0x0002
161 #define TONE_AMERICAN_DIALTONE 0x0003
162 #define TONE_GERMAN_DIALPBX 0x0004
163 #define TONE_GERMAN_OLDDIALPBX 0x0005
164 #define TONE_AMERICAN_DIALPBX 0x0006
165 #define TONE_GERMAN_RINGING 0x0007
166 #define TONE_GERMAN_OLDRINGING 0x0008
167 #define TONE_AMERICAN_RINGPBX 0x000b
168 #define TONE_GERMAN_RINGPBX 0x000c
169 #define TONE_GERMAN_OLDRINGPBX 0x000d
170 #define TONE_AMERICAN_RINGING 0x000e
171 #define TONE_GERMAN_BUSY 0x000f
172 #define TONE_GERMAN_OLDBUSY 0x0010
173 #define TONE_AMERICAN_BUSY 0x0011
174 #define TONE_GERMAN_HANGUP 0x0012
175 #define TONE_GERMAN_OLDHANGUP 0x0013
176 #define TONE_AMERICAN_HANGUP 0x0014
177 #define TONE_SPECIAL_INFO 0x0015
178 #define TONE_GERMAN_GASSENBESETZT 0x0016
179 #define TONE_GERMAN_AUFSCHALTTON 0x0016
181 /* MPH_INFORMATION_IND */
182 #define L1_SIGNAL_LOS_OFF 0x0010
183 #define L1_SIGNAL_LOS_ON 0x0011
184 #define L1_SIGNAL_AIS_OFF 0x0012
185 #define L1_SIGNAL_AIS_ON 0x0013
186 #define L1_SIGNAL_RDI_OFF 0x0014
187 #define L1_SIGNAL_RDI_ON 0x0015
188 #define L1_SIGNAL_SLIP_RX 0x0020
189 #define L1_SIGNAL_SLIP_TX 0x0021
192 * protocol ids
193 * D channel 1-31
194 * B channel 33 - 63
197 #define ISDN_P_NONE 0
198 #define ISDN_P_BASE 0
199 #define ISDN_P_TE_S0 0x01
200 #define ISDN_P_NT_S0 0x02
201 #define ISDN_P_TE_E1 0x03
202 #define ISDN_P_NT_E1 0x04
203 #define ISDN_P_TE_UP0 0x05
204 #define ISDN_P_NT_UP0 0x06
206 #define IS_ISDN_P_TE(p) ((p == ISDN_P_TE_S0) || (p == ISDN_P_TE_E1) || \
207 (p == ISDN_P_TE_UP0) || (p == ISDN_P_LAPD_TE))
208 #define IS_ISDN_P_NT(p) ((p == ISDN_P_NT_S0) || (p == ISDN_P_NT_E1) || \
209 (p == ISDN_P_NT_UP0) || (p == ISDN_P_LAPD_NT))
210 #define IS_ISDN_P_S0(p) ((p == ISDN_P_TE_S0) || (p == ISDN_P_NT_S0))
211 #define IS_ISDN_P_E1(p) ((p == ISDN_P_TE_E1) || (p == ISDN_P_NT_E1))
212 #define IS_ISDN_P_UP0(p) ((p == ISDN_P_TE_UP0) || (p == ISDN_P_NT_UP0))
215 #define ISDN_P_LAPD_TE 0x10
216 #define ISDN_P_LAPD_NT 0x11
218 #define ISDN_P_B_MASK 0x1f
219 #define ISDN_P_B_START 0x20
221 #define ISDN_P_B_RAW 0x21
222 #define ISDN_P_B_HDLC 0x22
223 #define ISDN_P_B_X75SLP 0x23
224 #define ISDN_P_B_L2DTMF 0x24
225 #define ISDN_P_B_L2DSP 0x25
226 #define ISDN_P_B_L2DSPHDLC 0x26
228 #define OPTION_L2_PMX 1
229 #define OPTION_L2_PTP 2
230 #define OPTION_L2_FIXEDTEI 3
231 #define OPTION_L2_CLEANUP 4
232 #define OPTION_L1_HOLD 5
234 /* should be in sync with linux/kobject.h:KOBJ_NAME_LEN */
235 #define MISDN_MAX_IDLEN 20
237 struct mISDNhead {
238 unsigned int prim;
239 unsigned int id;
240 } __attribute__((packed));
242 #define MISDN_HEADER_LEN sizeof(struct mISDNhead)
243 #define MAX_DATA_SIZE 2048
244 #define MAX_DATA_MEM (MAX_DATA_SIZE + MISDN_HEADER_LEN)
245 #define MAX_DFRAME_LEN 260
247 #define MISDN_ID_ADDR_MASK 0xFFFF
248 #define MISDN_ID_TEI_MASK 0xFF00
249 #define MISDN_ID_SAPI_MASK 0x00FF
250 #define MISDN_ID_TEI_ANY 0x7F00
252 #define MISDN_ID_ANY 0xFFFF
253 #define MISDN_ID_NONE 0xFFFE
255 #define GROUP_TEI 127
256 #define TEI_SAPI 63
257 #define CTRL_SAPI 0
259 #define MISDN_MAX_CHANNEL 127
260 #define MISDN_CHMAP_SIZE ((MISDN_MAX_CHANNEL + 1) >> 3)
262 #define SOL_MISDN 0
264 struct sockaddr_mISDN {
265 sa_family_t family;
266 unsigned char dev;
267 unsigned char channel;
268 unsigned char sapi;
269 unsigned char tei;
272 struct mISDNversion {
273 unsigned char major;
274 unsigned char minor;
275 unsigned short release;
278 struct mISDN_devinfo {
279 u_int id;
280 u_int Dprotocols;
281 u_int Bprotocols;
282 u_int protocol;
283 u_char channelmap[MISDN_CHMAP_SIZE];
284 u_int nrbchan;
285 char name[MISDN_MAX_IDLEN];
288 struct mISDN_devrename {
289 u_int id;
290 char name[MISDN_MAX_IDLEN]; /* new name */
293 /* MPH_INFORMATION_REQ payload */
294 struct ph_info_ch {
295 __u32 protocol;
296 __u64 Flags;
299 struct ph_info_dch {
300 struct ph_info_ch ch;
301 __u16 state;
302 __u16 num_bch;
305 struct ph_info {
306 struct ph_info_dch dch;
307 struct ph_info_ch bch[];
310 /* timer device ioctl */
311 #define IMADDTIMER _IOR('I', 64, int)
312 #define IMDELTIMER _IOR('I', 65, int)
314 /* socket ioctls */
315 #define IMGETVERSION _IOR('I', 66, int)
316 #define IMGETCOUNT _IOR('I', 67, int)
317 #define IMGETDEVINFO _IOR('I', 68, int)
318 #define IMCTRLREQ _IOR('I', 69, int)
319 #define IMCLEAR_L2 _IOR('I', 70, int)
320 #define IMSETDEVNAME _IOR('I', 71, struct mISDN_devrename)
321 #define IMHOLD_L1 _IOR('I', 72, int)
323 static inline int
324 test_channelmap(u_int nr, u_char *map)
326 if (nr <= MISDN_MAX_CHANNEL)
327 return map[nr >> 3] & (1 << (nr & 7));
328 else
329 return 0;
332 static inline void
333 set_channelmap(u_int nr, u_char *map)
335 map[nr >> 3] |= (1 << (nr & 7));
338 static inline void
339 clear_channelmap(u_int nr, u_char *map)
341 map[nr >> 3] &= ~(1 << (nr & 7));
344 /* CONTROL_CHANNEL parameters */
345 #define MISDN_CTRL_GETOP 0x0000
346 #define MISDN_CTRL_LOOP 0x0001
347 #define MISDN_CTRL_CONNECT 0x0002
348 #define MISDN_CTRL_DISCONNECT 0x0004
349 #define MISDN_CTRL_PCMCONNECT 0x0010
350 #define MISDN_CTRL_PCMDISCONNECT 0x0020
351 #define MISDN_CTRL_SETPEER 0x0040
352 #define MISDN_CTRL_UNSETPEER 0x0080
353 #define MISDN_CTRL_RX_OFF 0x0100
354 #define MISDN_CTRL_FILL_EMPTY 0x0200
355 #define MISDN_CTRL_GETPEER 0x0400
356 #define MISDN_CTRL_HW_FEATURES_OP 0x2000
357 #define MISDN_CTRL_HW_FEATURES 0x2001
358 #define MISDN_CTRL_HFC_OP 0x4000
359 #define MISDN_CTRL_HFC_PCM_CONN 0x4001
360 #define MISDN_CTRL_HFC_PCM_DISC 0x4002
361 #define MISDN_CTRL_HFC_CONF_JOIN 0x4003
362 #define MISDN_CTRL_HFC_CONF_SPLIT 0x4004
363 #define MISDN_CTRL_HFC_RECEIVE_OFF 0x4005
364 #define MISDN_CTRL_HFC_RECEIVE_ON 0x4006
365 #define MISDN_CTRL_HFC_ECHOCAN_ON 0x4007
366 #define MISDN_CTRL_HFC_ECHOCAN_OFF 0x4008
367 #define MISDN_CTRL_HFC_WD_INIT 0x4009
368 #define MISDN_CTRL_HFC_WD_RESET 0x400A
370 /* socket options */
371 #define MISDN_TIME_STAMP 0x0001
373 struct mISDN_ctrl_req {
374 int op;
375 int channel;
376 int p1;
377 int p2;
380 /* muxer options */
381 #define MISDN_OPT_ALL 1
382 #define MISDN_OPT_TEIMGR 2
384 #ifdef __KERNEL__
385 #include <linux/list.h>
386 #include <linux/skbuff.h>
387 #include <linux/net.h>
388 #include <net/sock.h>
389 #include <linux/completion.h>
391 #define DEBUG_CORE 0x000000ff
392 #define DEBUG_CORE_FUNC 0x00000002
393 #define DEBUG_SOCKET 0x00000004
394 #define DEBUG_MANAGER 0x00000008
395 #define DEBUG_SEND_ERR 0x00000010
396 #define DEBUG_MSG_THREAD 0x00000020
397 #define DEBUG_QUEUE_FUNC 0x00000040
398 #define DEBUG_L1 0x0000ff00
399 #define DEBUG_L1_FSM 0x00000200
400 #define DEBUG_L2 0x00ff0000
401 #define DEBUG_L2_FSM 0x00020000
402 #define DEBUG_L2_CTRL 0x00040000
403 #define DEBUG_L2_RECV 0x00080000
404 #define DEBUG_L2_TEI 0x00100000
405 #define DEBUG_L2_TEIFSM 0x00200000
406 #define DEBUG_TIMER 0x01000000
407 #define DEBUG_CLOCK 0x02000000
409 #define mISDN_HEAD_P(s) ((struct mISDNhead *)&s->cb[0])
410 #define mISDN_HEAD_PRIM(s) (((struct mISDNhead *)&s->cb[0])->prim)
411 #define mISDN_HEAD_ID(s) (((struct mISDNhead *)&s->cb[0])->id)
413 /* socket states */
414 #define MISDN_OPEN 1
415 #define MISDN_BOUND 2
416 #define MISDN_CLOSED 3
418 struct mISDNchannel;
419 struct mISDNdevice;
420 struct mISDNstack;
421 struct mISDNclock;
423 struct channel_req {
424 u_int protocol;
425 struct sockaddr_mISDN adr;
426 struct mISDNchannel *ch;
429 typedef int (ctrl_func_t)(struct mISDNchannel *, u_int, void *);
430 typedef int (send_func_t)(struct mISDNchannel *, struct sk_buff *);
431 typedef int (create_func_t)(struct channel_req *);
433 struct Bprotocol {
434 struct list_head list;
435 char *name;
436 u_int Bprotocols;
437 create_func_t *create;
440 struct mISDNchannel {
441 struct list_head list;
442 u_int protocol;
443 u_int nr;
444 u_long opt;
445 u_int addr;
446 struct mISDNstack *st;
447 struct mISDNchannel *peer;
448 send_func_t *send;
449 send_func_t *recv;
450 ctrl_func_t *ctrl;
453 struct mISDN_sock_list {
454 struct hlist_head head;
455 rwlock_t lock;
458 struct mISDN_sock {
459 struct sock sk;
460 struct mISDNchannel ch;
461 u_int cmask;
462 struct mISDNdevice *dev;
467 struct mISDNdevice {
468 struct mISDNchannel D;
469 u_int id;
470 u_int Dprotocols;
471 u_int Bprotocols;
472 u_int nrbchan;
473 u_char channelmap[MISDN_CHMAP_SIZE];
474 struct list_head bchannels;
475 struct mISDNchannel *teimgr;
476 struct device dev;
479 struct mISDNstack {
480 u_long status;
481 struct mISDNdevice *dev;
482 struct task_struct *thread;
483 struct completion *notify;
484 wait_queue_head_t workq;
485 struct sk_buff_head msgq;
486 struct list_head layer2;
487 struct mISDNchannel *layer1;
488 struct mISDNchannel own;
489 struct mutex lmutex; /* protect lists */
490 struct mISDN_sock_list l1sock;
491 #ifdef MISDN_MSG_STATS
492 u_int msg_cnt;
493 u_int sleep_cnt;
494 u_int stopped_cnt;
495 #endif
498 typedef int (clockctl_func_t)(void *, int);
500 struct mISDNclock {
501 struct list_head list;
502 char name[64];
503 int pri;
504 clockctl_func_t *ctl;
505 void *priv;
508 /* global alloc/queue functions */
510 static inline struct sk_buff *
511 mI_alloc_skb(unsigned int len, gfp_t gfp_mask)
513 struct sk_buff *skb;
515 skb = alloc_skb(len + MISDN_HEADER_LEN, gfp_mask);
516 if (likely(skb))
517 skb_reserve(skb, MISDN_HEADER_LEN);
518 return skb;
521 static inline struct sk_buff *
522 _alloc_mISDN_skb(u_int prim, u_int id, u_int len, void *dp, gfp_t gfp_mask)
524 struct sk_buff *skb = mI_alloc_skb(len, gfp_mask);
525 struct mISDNhead *hh;
527 if (!skb)
528 return NULL;
529 if (len)
530 memcpy(skb_put(skb, len), dp, len);
531 hh = mISDN_HEAD_P(skb);
532 hh->prim = prim;
533 hh->id = id;
534 return skb;
537 static inline void
538 _queue_data(struct mISDNchannel *ch, u_int prim,
539 u_int id, u_int len, void *dp, gfp_t gfp_mask)
541 struct sk_buff *skb;
543 if (!ch->peer)
544 return;
545 skb = _alloc_mISDN_skb(prim, id, len, dp, gfp_mask);
546 if (!skb)
547 return;
548 if (ch->recv(ch->peer, skb))
549 dev_kfree_skb(skb);
552 /* global register/unregister functions */
554 extern int mISDN_register_device(struct mISDNdevice *,
555 struct device *parent, char *name);
556 extern void mISDN_unregister_device(struct mISDNdevice *);
557 extern int mISDN_register_Bprotocol(struct Bprotocol *);
558 extern void mISDN_unregister_Bprotocol(struct Bprotocol *);
559 extern struct mISDNclock *mISDN_register_clock(char *, int, clockctl_func_t *,
560 void *);
561 extern void mISDN_unregister_clock(struct mISDNclock *);
563 static inline struct mISDNdevice *dev_to_mISDN(struct device *dev)
565 if (dev)
566 return dev_get_drvdata(dev);
567 else
568 return NULL;
571 extern void set_channel_address(struct mISDNchannel *, u_int, u_int);
572 extern void mISDN_clock_update(struct mISDNclock *, int, struct timeval *);
573 extern unsigned short mISDN_clock_get(void);
575 #endif /* __KERNEL__ */
576 #endif /* mISDNIF_H */