Makefile: Fix certified version numbers
[asterisk/asterisk.git] / include / asterisk / adsi.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief ADSI Support (built upon Caller*ID)
21  */
22
23 #ifndef _ASTERISK_ADSI_H
24 #define _ASTERISK_ADSI_H
25
26 #include "asterisk/callerid.h"
27
28 /*! \name ADSI parameters */
29 /*@{ */
30
31 /* ADSI Message types */
32 #define ADSI_MSG_DISPLAY        132
33 #define ADSI_MSG_DOWNLOAD       133
34
35 /* ADSI Parameters (display) */
36 #define ADSI_LOAD_SOFTKEY       128
37 #define ADSI_INIT_SOFTKEY_LINE  129
38 #define ADSI_LOAD_VIRTUAL_DISP  130
39 #define ADSI_LINE_CONTROL       131
40 #define ADSI_INFORMATION        132
41 #define ADSI_DISC_SESSION       133
42 #define ADSI_SWITCH_TO_DATA     134
43 #define ADSI_SWITCH_TO_VOICE    135
44 #define ADSI_CLEAR_SOFTKEY      136
45 #define ADSI_INPUT_CONTROL      137
46 #define ADSI_INPUT_FORMAT       138
47 #define ADSI_SWITCH_TO_PERIPH   139
48 #define ADSI_MOVE_DATA          140
49 #define ADSI_LOAD_DEFAULT       141
50 #define ADSI_CONNECT_SESSION    142
51 #define ADSI_CLEAR_TYPE_AHEAD   143
52 #define ADSI_DISPLAY_CALL_BUF   144
53 #define ADSI_CLEAR_CALL_BUF     145
54 #define ADSI_SWITCH_TO_ALT      146
55 #define ADSI_SWITCH_TO_GRAPHICS 147
56 #define ADSI_CLEAR_SCREEN       148
57 #define ADSI_QUERY_CONFIG       149
58 #define ADSI_QUERY_CPEID        150
59 #define ADSI_SWITCH_TO_APP      151
60
61 /* Feature download messages */
62 #define ADSI_LOAD_SOFTKEY_TABLE 128     /* Conveniently identical to the soft version */
63 #define ADSI_LOAD_PREDEF_DISP   129     /* Load predefined display */
64 #define ADSI_LOAD_SCRIPT        130
65 #define ADSI_DOWNLOAD_CONNECT   131
66 #define ADSI_DOWNLOAD_DISC      132
67
68 /* Special return string codes */
69 #define ADSI_ENCODED_DTMF       0x80    /* Transmit following chars with encoded dtmf */
70 #define ADSI_ON_HOOK            0x81    /* Open switch-hook */
71 #define ADSI_OFF_HOOK           0x82    /* Close switch-hook */
72 #define ADSI_FLASH              0x83    /* Flash switch-hook */
73 #define ADSI_DIAL_TONE_DETECT   0x84    /* Wait for dialtone */
74 #define ADSI_LINE_NUMBER        0x85    /* Send current line number using DTMF/encoded DTMF */
75 #define ADSI_BLANK              0x86    /* Blank (does nothing) */
76 #define ADSI_SEND_CHARS         0x87    /* Send collected digits/characters */
77 #define ADSI_CLEAR_CHARS        0x88    /* Clear characters/digits collected */
78 #define ADSI_BACKSPACE          0x89    /* Erase last collected digit */
79 #define ADSI_TAB_COLUMN         0x8A    /* Display specified display column of current line */
80 #define ADSI_GOTO_LINE          0x8B    /* Go to given page and line number */
81 #define ADSI_GOTO_LINE_REL      0x8C    /* Go to given line (relative to current) */
82 #define ADSI_PAGE_UP            0x8D    /* Go up one page */
83 #define ADSI_PAGE_DOWN          0x8E    /* Go down one page */
84 #define ADSI_EXTENDED_DTMF      0x8F    /* Send DTMF tones for 250ms instead of 60 ms */
85 #define ADSI_DELAY              0x90    /* Delay for given # (times 10) of ms */
86 #define ADSI_DIAL_PULSE_ONE     0x91    /* Send a dial pulse "1" */
87 #define ADSI_SWITCH_TO_DATA2    0x92    /* Switch CPE to data mode */
88 #define ADSI_SWITCH_TO_VOICE2   0x93    /* Switch CPE to voice mode */
89 #define ADSI_DISP_CALL_BUF      0x94    /* Display specified call buffer */
90 #define ADSI_CLEAR_CALL_B       0x95    /* Clear specified call buffer */
91
92 #ifdef __ADSI_CPE
93 /* These messages are reserved for the ADSI CPE only */
94 #define ADSI_DISPLAY_CONTROL    0x98    /* Store predefined display identified next / Display status display page */
95 #define ADSI_DISPLAY_SOFT_KEYS  0x99    /* Display the script soft keys identified next */
96 #define ADSI_CHANGE_STATE       0x9A    /* Change state of service script */
97 #define ADSI_START_CLEAR_TIMER  0x9B    /* Start / Clear timer */
98 #define ADSI_SET_SCRIPT_FLAG    0x9C    /* Set / clear a script flag */
99 #define ADSI_JUMP_TO_SUBSCRIPT  0x9D    /* Jump to specified subscript */
100 #define ADSI_EVENT_22_TRIGGER   0x9E    /* Trigger an occurance of event 22 */
101 #define ADSI_EVENT_23_TRIGGER   0x9f    /* Trigger an occurance of event 23 */
102 #define ADSI_EXIT               0xA0    /* Exit the service script interpreter */
103 #endif
104
105 /* Display pages */
106 #define ADSI_INFO_PAGE  0x0
107 #define ADSI_COMM_PAGE  0x1
108
109 #define ADSI_KEY_APPS   16      /* 16 to 33 reserved for applications */
110
111 /* Justification */
112 #define ADSI_JUST_LEFT  0x2
113 #define ADSI_JUST_RIGHT 0x1
114 #define ADSI_JUST_CENT  0x0     /* Center */
115 #define ADSI_JUST_IND   0x3     /* Indent */
116
117 #define ADSI_KEY_SKT    0x80    /* Load from SKT */
118 #define ADSI_KEY_HILITE 0x40    /* Highlight key */
119
120 #define ADSI_DIR_FROM_LEFT (0)
121 #define ADSI_DIR_FROM_RIGHT (1)
122
123 #define AST_ADSI_VERSION 1
124
125 /*@} */
126
127 int ast_adsi_begin_download(struct ast_channel *chan, char *service, unsigned char *fdn, unsigned char *sec, int version);
128
129 int ast_adsi_end_download(struct ast_channel *chan);
130
131 /*! Restore ADSI initialization (for applications that play with ADSI
132  *   and want to restore it to normal.  If you touch "INFO" then you
133  *   have to use the ast_adsi_channel_init again instead.
134  * \param chan Channel to restore
135  *
136  * \retval 0 on success (or adsi unavailable)
137  * \retval -1 on hangup
138  */
139 int ast_adsi_channel_restore(struct ast_channel *chan);
140
141 /*!
142  * \brief Display some stuff on the screen
143  * \param chan Channel to display on
144  * \param lines NULL-terminated list of things to print (no more than 4 recommended)
145  * \param align list of alignments to use (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CEN, etc..)
146  * \param voice whether to jump into voice mode when finished
147  *
148  * \retval 0 on success (or adsi unavailable)
149  * \retval -1 on hangup
150  */
151 int ast_adsi_print(struct ast_channel *chan, char **lines, int *align, int voice);
152
153 /*!
154  * \brief Check if scripts for a given app are already loaded.
155  * Version may be -1, if any version is okay, or 0-255 for a specific version.
156  * \param chan Channel to test for loaded app
157  * \param app Four character app name (must be unique to your application)
158  * \param ver optional version number
159  * \param data Non-zero if you want to be put in data mode
160  *
161  * \retval 0 if scripts is not loaded or not an ADSI CPE
162  * \retval -1 on hangup
163  * \retval 1 if script already loaded.
164  */
165 int ast_adsi_load_session(struct ast_channel *chan, unsigned char *app, int ver, int data);
166 int ast_adsi_unload_session(struct ast_channel *chan);
167
168 /* ADSI Layer 2 transmission functions */
169 int ast_adsi_transmit_message(struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype);
170 int ast_adsi_transmit_message_full(struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype, int dowait);
171 /*! Read some encoded DTMF data.
172  * Returns number of bytes received
173  */
174 int ast_adsi_read_encoded_dtmf(struct ast_channel *chan, unsigned char *buf, int maxlen);
175
176 /* ADSI Layer 3 creation functions */
177
178 /*!
179  * \brief Connects an ADSI Display Session
180  * \param buf Character buffer to create parameter in (must have at least 256 free)
181  * \param fdn Optional 4 byte Feature Download Number (for loading soft keys)
182  * \param ver Optional version number (0-255, or -1 to omit)
183  *
184  * \retval number of bytes added to buffer
185  * \retval -1 on error.
186  */
187
188 int ast_adsi_connect_session(unsigned char *buf, unsigned char *fdn, int ver);
189
190 /*! Build Query CPE ID of equipment.
191  *  Returns number of bytes added to message
192  */
193 int ast_adsi_query_cpeid(unsigned char *buf);
194 int ast_adsi_query_cpeinfo(unsigned char *buf);
195
196 /*! Get CPE ID from an attached ADSI compatible CPE.
197  * Returns 1 on success, storing 4 bytes of CPE ID at buf
198  * or -1 on hangup, or 0 if there was no hangup but it failed to find the
199  * device ID.  Returns to voice mode if "voice" is non-zero.
200  */
201 int ast_adsi_get_cpeid(struct ast_channel *chan, unsigned char *cpeid, int voice);
202
203 int ast_adsi_get_cpeinfo(struct ast_channel *chan, int *width, int *height, int *buttons, int voice);
204
205 /*!
206  * \brief Begin an ADSI script download
207  * \param buf Character buffer to create parameter in (must have at least 256 free)
208  * \param service a 1-18 byte name of the feature
209  * \param fdn 4 byte Feature Download Number (for loading soft keys)
210  * \param sec 4 byte vendor security code
211  * \param ver version number (0-255, or -1 to omit)
212  *
213  * \retval number of bytes added to buffer
214  * \retval -1 on error.
215  */
216
217 int ast_adsi_download_connect(unsigned char *buf, char *service, unsigned char *fdn, unsigned char *sec, int ver);
218
219 /*!
220  * \brief Disconnects a running session.
221  * \param buf Character buffer to create parameter in (must have at least 256 free)
222  *
223  * \retval number of bytes added to buffer
224  * \retval -1 on error.
225  */
226 int ast_adsi_disconnect_session(unsigned char *buf);
227
228 /*!
229  * \brief Disconnects (and hopefully saves) a downloaded script
230  * \param buf Character buffer to create parameter in (must have at least 256 free)
231  *
232  * \retval number of bytes added to buffer
233  * \retval -1 on error.
234  */
235 int ast_adsi_download_disconnect(unsigned char *buf);
236
237 /*!
238  * \brief Puts CPE in data mode.
239  * \param buf Character buffer to create parameter in (must have at least 256 free)
240  *
241  * \retval number of bytes added to buffer
242  * \retval -1 on error.
243  */
244 int ast_adsi_data_mode(unsigned char *buf);
245 int ast_adsi_clear_soft_keys(unsigned char *buf);
246 int ast_adsi_clear_screen(unsigned char *buf);
247
248 /*!
249  * \brief Puts CPE in voice mode.
250  * \param buf Character buffer to create parameter in (must have at least 256 free)
251  * \param when (a time in seconds) to make the switch
252  *
253  * \retval number of bytes added to buffer
254  * \retval -1 on error.
255  */
256 int ast_adsi_voice_mode(unsigned char *buf, int when);
257
258 /*!
259  * \brief Returns non-zero if Channel does or might support ADSI
260  * \param chan Channel to check
261  */
262 int ast_adsi_available(struct ast_channel *chan);
263
264 /*!
265  * \brief Loads a line of info into the display.
266  * \param buf Character buffer to create parameter in (must have at least 256 free)
267  * \param page Page to load (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
268  * \param line Line number to load (1-4 for Comm page, 1-33 for info page)
269  * \param just Line justification (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CENT, ADSI_JUST_IND)
270  * \param wrap Wrap (1 = yes, 0 = no)
271  * \param col1 Text to place in first column
272  * \param col2 Text to place in second column
273  *
274  * \retval number of bytes added to buffer
275  * \retval -1 on error.
276  */
277
278 int ast_adsi_display(unsigned char *buf, int page, int line, int just, int wrap, char *col1, char *col2);
279
280 /*!
281  * \brief Sets the current line and page.
282  * \param buf Character buffer to create parameter in (must have at least 256 free)
283  * \param page Which page (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
284  * \param line Line number (1-33 for info page, 1-4 for comm page)
285  *
286  * \retval number of bytes added to buffer
287  * \retval -1 on error.
288  */
289
290 int ast_adsi_set_line(unsigned char *buf, int page, int line);
291
292 /*!
293  * \brief Creates "load soft key" parameters
294  * \param buf Character buffer to create parameter in (must have at least 256 free)
295  * \param key Key code from 2 to 33, for which key we are loading
296  * \param llabel Long label for key (1-18 bytes)
297  * \param slabel Short label for key (1-7 bytes)
298  * \param ret Optional return sequence (NULL for none)
299  * \param data whether to put CPE in data mode before sending digits
300  *
301  * \retval number of bytes added to buffer
302  * \retval -1 on error.
303  */
304 int ast_adsi_load_soft_key(unsigned char *buf, int key, const char *llabel, const char *slabel, char *ret, int data);
305
306 /*!
307  * \brief Set which soft keys should be displayed
308  * \param buf Character buffer to create parameter in (must have at least 256 free)
309  * \param keys Array of 8 unsigned chars with the key numbers, may be OR'd with ADSI_KEY_HILITE
310  *             But remember, the last two keys aren't real keys, they're for scrolling
311  *
312  * \retval number of bytes added to buffer
313  * \retval -1 on error.
314  */
315 int ast_adsi_set_keys(unsigned char *buf, unsigned char *keys);
316
317 /*!
318  * \brief Set input information
319  * \param buf Character buffer to create parameter in (must have at least 256 free)
320  * \param page Which page to input on (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
321  * \param line Line number to input on
322  * \param display Set to zero to obscure input, or 1 to leave visible
323  * \param format Format number to use (0-7)
324  * \param just Justification (left, right center, indent)
325  *
326  * \retval number of bytes added to buffer
327  * \retval -1 on error.
328  */
329 int ast_adsi_input_control(unsigned char *buf, int page, int line, int display, int format, int just);
330
331 /*!
332  * \brief Set input format
333  * \param buf Character buffer to create parameter in (must have at least 256 free)
334  * \param num Which format we are setting
335  * \param dir Which direction (ADSI_DIR_FROM_LEFT or ADSI_DIR_FROM_RIGHT)
336  * \param wrap Set to 1 to permit line wrap, or 0 if not
337  * \param format1 Format for column 1
338  * \param format2 Format for column 2
339  *
340  * \retval number of bytes added to buffer
341  * \retval -1 on error.
342  */
343 int ast_adsi_input_format(unsigned char *buf, int num, int dir, int wrap, char *format1, char *format2);
344
345 struct adsi_funcs {
346         unsigned int version;
347         int (*begin_download)(struct ast_channel *chan, char *service, unsigned char *fdn, unsigned char *sec, int version);
348         int (*end_download)(struct ast_channel *chan);
349         int (*channel_restore) (struct ast_channel *chan);
350         int (*print) (struct ast_channel *chan, char **lines, int *align, int voice);
351         int (*load_session) (struct ast_channel *chan, unsigned char *app, int ver, int data);
352         int (*unload_session) (struct ast_channel *chan);
353         int (*transmit_message) (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype);
354         int (*transmit_message_full) (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype, int dowait);
355         int (*read_encoded_dtmf) (struct ast_channel *chan, unsigned char *buf, int maxlen);
356         int (*connect_session) (unsigned char *buf, unsigned char *fdn, int ver);
357         int (*query_cpeid) (unsigned char *buf);
358         int (*query_cpeinfo) (unsigned char *buf);
359         int (*get_cpeid) (struct ast_channel *chan, unsigned char *cpeid, int voice);
360         int (*get_cpeinfo) (struct ast_channel *chan, int *width, int *height, int *buttons, int voice);
361         int (*download_connect) (unsigned char *buf, char *service, unsigned char *fdn, unsigned char *sec, int ver);
362         int (*disconnect_session) (unsigned char *buf);
363         int (*download_disconnect) (unsigned char *buf);
364         int (*data_mode) (unsigned char *buf);
365         int (*clear_soft_keys) (unsigned char *buf);
366         int (*clear_screen) (unsigned char *buf);
367         int (*voice_mode) (unsigned char *buf, int when);
368         int (*available) (struct ast_channel *chan);
369         int (*display) (unsigned char *buf, int page, int line, int just, int wrap, char *col1, char *col2);
370         int (*set_line) (unsigned char *buf, int page, int line);
371         int (*load_soft_key) (unsigned char *buf, int key, const char *llabel, const char *slabel, char *ret, int data);
372         int (*set_keys) (unsigned char *buf, unsigned char *keys);
373         int (*input_control) (unsigned char *buf, int page, int line, int display, int format, int just);
374         int (*input_format) (unsigned char *buf, int num, int dir, int wrap, char *format1, char *format2);
375 };
376
377 void ast_adsi_install_funcs(const struct adsi_funcs *funcs);
378
379 #endif /* _ASTERISK_ADSI_H */