Codename Pineapple

Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:00:59 2007

Asterisk developer's documentation :: Codename Pineapple


adsi.h File Reference


Detailed Description

ADSI Support (built upon Caller*ID).

Definition in file adsi.h.

#include "asterisk/callerid.h"

Include dependency graph for adsi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define ADSI_BACKSPACE   0x89
#define ADSI_BLANK   0x86
#define ADSI_CLEAR_CALL_B   0x95
#define ADSI_CLEAR_CALL_BUF   145
#define ADSI_CLEAR_CHARS   0x88
#define ADSI_CLEAR_SCREEN   148
#define ADSI_CLEAR_SOFTKEY   136
#define ADSI_CLEAR_TYPE_AHEAD   143
#define ADSI_COMM_PAGE   0x1
#define ADSI_CONNECT_SESSION   142
#define ADSI_DELAY   0x90
#define ADSI_DIAL_PULSE_ONE   0x91
#define ADSI_DIAL_TONE_DETECT   0x84
#define ADSI_DIR_FROM_LEFT   (0)
#define ADSI_DIR_FROM_RIGHT   (1)
#define ADSI_DISC_SESSION   133
#define ADSI_DISP_CALL_BUF   0x94
#define ADSI_DISPLAY_CALL_BUF   144
#define ADSI_DOWNLOAD_CONNECT   131
#define ADSI_DOWNLOAD_DISC   132
#define ADSI_ENCODED_DTMF   0x80
#define ADSI_EXTENDED_DTMF   0x8F
#define ADSI_FLASH   0x83
#define ADSI_GOTO_LINE   0x8B
#define ADSI_GOTO_LINE_REL   0x8C
#define ADSI_INFO_PAGE   0x0
#define ADSI_INFORMATION   132
#define ADSI_INIT_SOFTKEY_LINE   129
#define ADSI_INPUT_CONTROL   137
#define ADSI_INPUT_FORMAT   138
#define ADSI_JUST_CENT   0x0
#define ADSI_JUST_IND   0x3
#define ADSI_JUST_LEFT   0x2
#define ADSI_JUST_RIGHT   0x1
#define ADSI_KEY_APPS   16
#define ADSI_KEY_HILITE   0x40
#define ADSI_KEY_SKT   0x80
#define ADSI_LINE_CONTROL   131
#define ADSI_LINE_NUMBER   0x85
#define ADSI_LOAD_DEFAULT   141
#define ADSI_LOAD_PREDEF_DISP   129
#define ADSI_LOAD_SCRIPT   130
#define ADSI_LOAD_SOFTKEY   128
#define ADSI_LOAD_SOFTKEY_TABLE   128
#define ADSI_LOAD_VIRTUAL_DISP   130
#define ADSI_MOVE_DATA   140
#define ADSI_MSG_DISPLAY   132
#define ADSI_MSG_DOWNLOAD   133
#define ADSI_OFF_HOOK   0x82
#define ADSI_ON_HOOK   0x81
#define ADSI_PAGE_DOWN   0x8E
#define ADSI_PAGE_UP   0x8D
#define ADSI_QUERY_CONFIG   149
#define ADSI_QUERY_CPEID   150
#define ADSI_SEND_CHARS   0x87
#define ADSI_SWITCH_TO_ALT   146
#define ADSI_SWITCH_TO_APP   151
#define ADSI_SWITCH_TO_DATA   134
#define ADSI_SWITCH_TO_DATA2   0x92
#define ADSI_SWITCH_TO_GRAPHICS   147
#define ADSI_SWITCH_TO_PERIPH   139
#define ADSI_SWITCH_TO_VOICE   135
#define ADSI_SWITCH_TO_VOICE2   0x93
#define ADSI_TAB_COLUMN   0x8A

Functions

int ast_adsi_available (struct ast_channel *chan)
int ast_adsi_begin_download (struct ast_channel *chan, char *service, unsigned char *fdn, unsigned char *sec, int version)
int ast_adsi_channel_init (struct ast_channel *chan)
int ast_adsi_channel_restore (struct ast_channel *chan)
int ast_adsi_clear_screen (unsigned char *buf)
int ast_adsi_clear_soft_keys (unsigned char *buf)
int ast_adsi_connect_session (unsigned char *buf, unsigned char *fdn, int ver)
int ast_adsi_data_mode (unsigned char *buf)
int ast_adsi_disconnect_session (unsigned char *buf)
int ast_adsi_display (unsigned char *buf, int page, int line, int just, int wrap, char *col1, char *col2)
int ast_adsi_download_connect (unsigned char *buf, char *service, unsigned char *fdn, unsigned char *sec, int ver)
int ast_adsi_download_disconnect (unsigned char *buf)
int ast_adsi_end_download (struct ast_channel *chan)
int ast_adsi_get_cpeid (struct ast_channel *chan, unsigned char *cpeid, int voice)
int ast_adsi_get_cpeinfo (struct ast_channel *chan, int *width, int *height, int *buttons, int voice)
int ast_adsi_input_control (unsigned char *buf, int page, int line, int display, int format, int just)
int ast_adsi_input_format (unsigned char *buf, int num, int dir, int wrap, char *format1, char *format2)
int ast_adsi_load_session (struct ast_channel *chan, unsigned char *app, int ver, int data)
int ast_adsi_load_soft_key (unsigned char *buf, int key, const char *llabel, const char *slabel, const char *ret, int data)
int ast_adsi_print (struct ast_channel *chan, char **lines, int *align, int voice)
int ast_adsi_query_cpeid (unsigned char *buf)
int ast_adsi_query_cpeinfo (unsigned char *buf)
int ast_adsi_read_encoded_dtmf (struct ast_channel *chan, unsigned char *buf, int maxlen)
int ast_adsi_set_keys (unsigned char *buf, unsigned char *keys)
int ast_adsi_set_line (unsigned char *buf, int page, int line)
int ast_adsi_transmit_message (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype)
int ast_adsi_transmit_message_full (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype, int dowait)
int ast_adsi_transmit_messages (struct ast_channel *chan, unsigned char **msg, int *msglen, int *msgtype)
int ast_adsi_unload_session (struct ast_channel *chan)
int ast_adsi_voice_mode (unsigned char *buf, int when)


Define Documentation

#define ADSI_BACKSPACE   0x89
 

Definition at line 75 of file adsi.h.

#define ADSI_BLANK   0x86
 

Definition at line 72 of file adsi.h.

#define ADSI_CLEAR_CALL_B   0x95
 

Definition at line 87 of file adsi.h.

#define ADSI_CLEAR_CALL_BUF   145
 

Definition at line 50 of file adsi.h.

#define ADSI_CLEAR_CHARS   0x88
 

Definition at line 74 of file adsi.h.

#define ADSI_CLEAR_SCREEN   148
 

Definition at line 53 of file adsi.h.

Referenced by ast_adsi_clear_screen().

#define ADSI_CLEAR_SOFTKEY   136
 

Definition at line 41 of file adsi.h.

Referenced by ast_adsi_clear_soft_keys().

#define ADSI_CLEAR_TYPE_AHEAD   143
 

Definition at line 48 of file adsi.h.

#define ADSI_COMM_PAGE   0x1
 

Definition at line 104 of file adsi.h.

#define ADSI_CONNECT_SESSION   142
 

Definition at line 47 of file adsi.h.

Referenced by ast_adsi_connect_session().

#define ADSI_DELAY   0x90
 

Definition at line 82 of file adsi.h.

#define ADSI_DIAL_PULSE_ONE   0x91
 

Definition at line 83 of file adsi.h.

#define ADSI_DIAL_TONE_DETECT   0x84
 

Definition at line 70 of file adsi.h.

#define ADSI_DIR_FROM_LEFT   (0)
 

Definition at line 117 of file adsi.h.

#define ADSI_DIR_FROM_RIGHT   (1)
 

Definition at line 118 of file adsi.h.

#define ADSI_DISC_SESSION   133
 

Definition at line 38 of file adsi.h.

Referenced by ast_adsi_disconnect_session().

#define ADSI_DISP_CALL_BUF   0x94
 

Definition at line 86 of file adsi.h.

#define ADSI_DISPLAY_CALL_BUF   144
 

Definition at line 49 of file adsi.h.

#define ADSI_DOWNLOAD_CONNECT   131
 

Definition at line 62 of file adsi.h.

Referenced by ast_adsi_download_connect().

#define ADSI_DOWNLOAD_DISC   132
 

Definition at line 63 of file adsi.h.

Referenced by ast_adsi_download_disconnect().

#define ADSI_ENCODED_DTMF   0x80
 

Definition at line 66 of file adsi.h.

#define ADSI_EXTENDED_DTMF   0x8F
 

Definition at line 81 of file adsi.h.

#define ADSI_FLASH   0x83
 

Definition at line 69 of file adsi.h.

#define ADSI_GOTO_LINE   0x8B
 

Definition at line 77 of file adsi.h.

#define ADSI_GOTO_LINE_REL   0x8C
 

Definition at line 78 of file adsi.h.

#define ADSI_INFO_PAGE   0x0
 

Definition at line 103 of file adsi.h.

Referenced by ast_adsi_channel_restore(), and ast_adsi_print().

#define ADSI_INFORMATION   132
 

Definition at line 37 of file adsi.h.

#define ADSI_INIT_SOFTKEY_LINE   129
 

Definition at line 34 of file adsi.h.

Referenced by ast_adsi_set_keys().

#define ADSI_INPUT_CONTROL   137
 

Definition at line 42 of file adsi.h.

Referenced by ast_adsi_input_control().

#define ADSI_INPUT_FORMAT   138
 

Definition at line 43 of file adsi.h.

Referenced by ast_adsi_input_format().

#define ADSI_JUST_CENT   0x0
 

Definition at line 111 of file adsi.h.

Referenced by adsi_announce_park(), init_state(), and str2align().

#define ADSI_JUST_IND   0x3
 

Definition at line 112 of file adsi.h.

Referenced by str2align().

#define ADSI_JUST_LEFT   0x2
 

Definition at line 109 of file adsi.h.

Referenced by str2align().

#define ADSI_JUST_RIGHT   0x1
 

Definition at line 110 of file adsi.h.

Referenced by str2align().

#define ADSI_KEY_APPS   16
 

Definition at line 106 of file adsi.h.

#define ADSI_KEY_HILITE   0x40
 

Definition at line 115 of file adsi.h.

#define ADSI_KEY_SKT   0x80
 

Definition at line 114 of file adsi.h.

#define ADSI_LINE_CONTROL   131
 

Definition at line 36 of file adsi.h.

Referenced by ast_adsi_set_line().

#define ADSI_LINE_NUMBER   0x85
 

Definition at line 71 of file adsi.h.

#define ADSI_LOAD_DEFAULT   141
 

Definition at line 46 of file adsi.h.

#define ADSI_LOAD_PREDEF_DISP   129
 

Definition at line 60 of file adsi.h.

#define ADSI_LOAD_SCRIPT   130
 

Definition at line 61 of file adsi.h.

#define ADSI_LOAD_SOFTKEY   128
 

Definition at line 33 of file adsi.h.

Referenced by ast_adsi_load_soft_key().

#define ADSI_LOAD_SOFTKEY_TABLE   128
 

Definition at line 59 of file adsi.h.

#define ADSI_LOAD_VIRTUAL_DISP   130
 

Definition at line 35 of file adsi.h.

Referenced by ast_adsi_display().

#define ADSI_MOVE_DATA   140
 

Definition at line 45 of file adsi.h.

#define ADSI_MSG_DISPLAY   132
 

Definition at line 29 of file adsi.h.

Referenced by ast_adsi_get_cpeid(), ast_adsi_get_cpeinfo(), ast_adsi_load_session(), ast_adsi_print(), and ast_adsi_unload_session().

#define ADSI_MSG_DOWNLOAD   133
 

Definition at line 30 of file adsi.h.

Referenced by ast_adsi_begin_download(), and ast_adsi_end_download().

#define ADSI_OFF_HOOK   0x82
 

Definition at line 68 of file adsi.h.

#define ADSI_ON_HOOK   0x81
 

Definition at line 67 of file adsi.h.

#define ADSI_PAGE_DOWN   0x8E
 

Definition at line 80 of file adsi.h.

#define ADSI_PAGE_UP   0x8D
 

Definition at line 79 of file adsi.h.

#define ADSI_QUERY_CONFIG   149
 

Definition at line 54 of file adsi.h.

Referenced by ast_adsi_query_cpeinfo().

#define ADSI_QUERY_CPEID   150
 

Definition at line 55 of file adsi.h.

Referenced by ast_adsi_query_cpeid().

#define ADSI_SEND_CHARS   0x87
 

Definition at line 73 of file adsi.h.

#define ADSI_SWITCH_TO_ALT   146
 

Definition at line 51 of file adsi.h.

#define ADSI_SWITCH_TO_APP   151
 

Definition at line 56 of file adsi.h.

#define ADSI_SWITCH_TO_DATA   134
 

Definition at line 39 of file adsi.h.

Referenced by ast_adsi_data_mode(), and ast_adsi_transmit_message_full().

#define ADSI_SWITCH_TO_DATA2   0x92
 

Definition at line 84 of file adsi.h.

Referenced by ast_adsi_load_soft_key().

#define ADSI_SWITCH_TO_GRAPHICS   147
 

Definition at line 52 of file adsi.h.

#define ADSI_SWITCH_TO_PERIPH   139
 

Definition at line 44 of file adsi.h.

#define ADSI_SWITCH_TO_VOICE   135
 

Definition at line 40 of file adsi.h.

Referenced by ast_adsi_transmit_message_full(), and ast_adsi_voice_mode().

#define ADSI_SWITCH_TO_VOICE2   0x93
 

Definition at line 85 of file adsi.h.

#define ADSI_TAB_COLUMN   0x8A
 

Definition at line 76 of file adsi.h.


Function Documentation

int ast_adsi_available struct ast_channel chan  ) 
 

Parameters:
chan Channel to check

Definition at line 787 of file res_adsi.c.

References ast_channel::adsicpe, AST_ADSI_AVAILABLE, and AST_ADSI_UNKNOWN.

00788 {
00789    int cpe = chan->adsicpe & 0xff;
00790    if ((cpe == AST_ADSI_AVAILABLE) ||
00791        (cpe == AST_ADSI_UNKNOWN))
00792       return 1;
00793    return 0;
00794 }

int ast_adsi_begin_download struct ast_channel chan,
char *  service,
unsigned char *  fdn,
unsigned char *  sec,
int  version
 

Definition at line 336 of file res_adsi.c.

References ADSI_MSG_DOWNLOAD, ast_adsi_download_connect(), ast_adsi_transmit_message_full(), ast_log(), ast_readstring(), and option_debug.

00337 {
00338    int bytes;
00339    unsigned char buf[256];
00340    char ack[2];
00341    bytes = 0;
00342    /* Setup the resident soft key stuff, a piece at a time */
00343    /* Upload what scripts we can for voicemail ahead of time */
00344    bytes += ast_adsi_download_connect(buf + bytes, service, fdn, sec, version);
00345    if (ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DOWNLOAD, 0))
00346       return -1;
00347    if (ast_readstring(chan, ack, 1, 10000, 10000, ""))
00348       return -1;
00349    if (ack[0] == 'B')
00350       return 0;
00351    if (option_debug)
00352       ast_log(LOG_DEBUG, "Download was denied by CPE\n");
00353    return -1;
00354 }

int ast_adsi_channel_init struct ast_channel chan  ) 
 

Parameters:
chan Channel to initialize for ADSI (if supported)
Returns 0 on success (or adsi unavailable) and -1 on hangup

int ast_adsi_channel_restore struct ast_channel chan  ) 
 

Parameters:
chan Channel to restore
Returns 0 on success (or adsi unavailable) and -1 on hangup

Definition at line 945 of file res_adsi.c.

References ADSI_INFO_PAGE, ADSI_SPEED_DIAL, ast_adsi_set_keys(), and ast_adsi_set_line().

00946 {
00947    unsigned char dsp[256];
00948    int bytes;
00949    int x;
00950    unsigned char keyd[6];
00951 
00952    memset(dsp, 0, sizeof(dsp));
00953 
00954    /* Start with initial display setup */
00955    bytes = 0;
00956    bytes += ast_adsi_set_line(dsp + bytes, ADSI_INFO_PAGE, 1);
00957 
00958    /* Prepare key setup messages */
00959 
00960    if (speeds) {
00961       memset(keyd, 0, sizeof(keyd));
00962       for (x=0;x<speeds;x++) {
00963          keyd[x] = ADSI_SPEED_DIAL + x;
00964       }
00965       bytes += ast_adsi_set_keys(dsp + bytes, keyd);
00966    }
00967    ast_adsi_transmit_message_full(chan, dsp, bytes, ADSI_MSG_DISPLAY, 0);
00968    return 0;
00969 
00970 }

int ast_adsi_clear_screen unsigned char *  buf  ) 
 

Definition at line 755 of file res_adsi.c.

References ADSI_CLEAR_SCREEN.

00756 {
00757    int bytes=0;
00758 
00759    /* Message type */
00760    buf[bytes++] = ADSI_CLEAR_SCREEN;
00761 
00762    /* Reserve space for length */
00763    bytes++;
00764 
00765    buf[1] = bytes - 2;
00766    return bytes;
00767 
00768 }

int ast_adsi_clear_soft_keys unsigned char *  buf  ) 
 

Definition at line 740 of file res_adsi.c.

References ADSI_CLEAR_SOFTKEY.

00741 {
00742    int bytes=0;
00743 
00744    /* Message type */
00745    buf[bytes++] = ADSI_CLEAR_SOFTKEY;
00746 
00747    /* Reserve space for length */
00748    bytes++;
00749 
00750    buf[1] = bytes - 2;
00751    return bytes;
00752 
00753 }

int ast_adsi_connect_session unsigned char *  buf,
unsigned char *  fdn,
int  ver
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
fdn Optional 4 byte Feature Download Number (for loading soft keys)
ver Optional version number (0-255, or -1 to omit)
Returns number of bytes added to buffer or -1 on error.

Definition at line 505 of file res_adsi.c.

References ADSI_CONNECT_SESSION.

Referenced by ast_adsi_load_session().

00506 {
00507    int bytes=0;
00508    int x;
00509 
00510    /* Message type */
00511    buf[bytes++] = ADSI_CONNECT_SESSION;
00512 
00513    /* Reserve space for length */
00514    bytes++;
00515 
00516    if (fdn) {
00517       for (x=0;x<4;x++)
00518          buf[bytes++] = fdn[x];
00519       if (ver > -1)
00520          buf[bytes++] = ver & 0xff;
00521    }
00522 
00523    buf[1] = bytes - 2;
00524    return bytes;
00525 
00526 }

int ast_adsi_data_mode unsigned char *  buf  ) 
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
Returns number of bytes added to buffer or -1 on error.

Definition at line 725 of file res_adsi.c.

References ADSI_SWITCH_TO_DATA.

Referenced by ast_adsi_get_cpeid(), ast_adsi_get_cpeinfo(), and ast_adsi_load_session().

00726 {
00727    int bytes=0;
00728 
00729    /* Message type */
00730    buf[bytes++] = ADSI_SWITCH_TO_DATA;
00731 
00732    /* Reserve space for length */
00733    bytes++;
00734 
00735    buf[1] = bytes - 2;
00736    return bytes;
00737 
00738 }

int ast_adsi_disconnect_session unsigned char *  buf  ) 
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
Returns number of bytes added to buffer or -1 on error.

Definition at line 558 of file res_adsi.c.

References ADSI_DISC_SESSION.

Referenced by ast_adsi_unload_session().

00559 {
00560    int bytes=0;
00561 
00562    /* Message type */
00563    buf[bytes++] = ADSI_DISC_SESSION;
00564 
00565    /* Reserve space for length */
00566    bytes++;
00567 
00568    buf[1] = bytes - 2;
00569    return bytes;
00570 
00571 }

int ast_adsi_display unsigned char *  buf,
int  page,
int  line,
int  just,
int  wrap,
char *  col1,
char *  col2
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
page Page to load (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
line Line number to load (1-4 for Comm page, 1-33 for info page)
just Line justification (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CENT, ADSI_JUST_IND)
wrap Wrap (1 = yes, 0 = no)
col1 Text to place in first column
col2 Text to place in second column
Returns number of bytes added to buffer or -1 on error.

Definition at line 811 of file res_adsi.c.

References ADSI_LOAD_VIRTUAL_DISP, and ccopy().

Referenced by ast_adsi_print().

00813 {
00814    int bytes=0;
00815 
00816    /* Sanity check line number */
00817 
00818    if (page) {
00819       if (line > 4) return -1;
00820    } else {
00821       if (line > 33) return -1;
00822    }
00823 
00824    if (line < 1)
00825       return -1;
00826    /* Parameter type */
00827    buf[bytes++] = ADSI_LOAD_VIRTUAL_DISP;
00828    
00829    /* Reserve space for size */
00830    bytes++;
00831 
00832    /* Page and wrap indicator */
00833    buf[bytes++] = ((page & 0x1) << 7) | ((wrap & 0x1) << 6) | (line & 0x3f);
00834 
00835    /* Justification */
00836    buf[bytes++] = (just & 0x3) << 5;
00837 
00838    /* Omit highlight mode definition */
00839    buf[bytes++] = 0xff;
00840 
00841    /* Primary column */
00842    bytes+= ccopy(buf + bytes, (unsigned char *)col1, 20);
00843 
00844    /* Delimiter */
00845    buf[bytes++] = 0xff;
00846    
00847    /* Secondary column */
00848    bytes += ccopy(buf + bytes, (unsigned char *)col2, 20);
00849 
00850    /* Update length */
00851    buf[1] = bytes - 2;
00852    
00853    return bytes;
00854 
00855 }

int ast_adsi_download_connect unsigned char *  buf,
char *  service,
unsigned char *  fdn,
unsigned char *  sec,
int  ver
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
service a 1-18 byte name of the feature
fdn 4 byte Feature Download Number (for loading soft keys)
sec 4 byte vendor security code
ver version number (0-255, or -1 to omit)
Returns number of bytes added to buffer or -1 on error.

Definition at line 528 of file res_adsi.c.

References ADSI_DOWNLOAD_CONNECT, and ccopy().

Referenced by ast_adsi_begin_download().

00529 {
00530    int bytes=0;
00531    int x;
00532 
00533    /* Message type */
00534    buf[bytes++] = ADSI_DOWNLOAD_CONNECT;
00535 
00536    /* Reserve space for length */
00537    bytes++;
00538 
00539    /* Primary column */
00540    bytes+= ccopy(buf + bytes, (unsigned char *)service, 18);
00541 
00542    /* Delimiter */
00543    buf[bytes++] = 0xff;
00544    
00545    for (x=0;x<4;x++) {
00546       buf[bytes++] = fdn[x];
00547    }
00548    for (x=0;x<4;x++)
00549       buf[bytes++] = sec[x];
00550    buf[bytes++] = ver & 0xff;
00551 
00552    buf[1] = bytes - 2;
00553 
00554    return bytes;
00555 
00556 }

int ast_adsi_download_disconnect unsigned char *  buf  ) 
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
Returns number of bytes added to buffer or -1 on error.

Definition at line 796 of file res_adsi.c.

References ADSI_DOWNLOAD_DISC.

Referenced by ast_adsi_end_download().

00797 {
00798    int bytes=0;
00799 
00800    /* Message type */
00801    buf[bytes++] = ADSI_DOWNLOAD_DISC;
00802 
00803    /* Reserve space for length */
00804    bytes++;
00805 
00806    buf[1] = bytes - 2;
00807    return bytes;
00808 
00809 }

int ast_adsi_end_download struct ast_channel chan  ) 
 

Definition at line 356 of file res_adsi.c.

References ADSI_MSG_DOWNLOAD, ast_adsi_download_disconnect(), and ast_adsi_transmit_message_full().

00357 {
00358    int bytes;
00359    unsigned char buf[256];
00360         bytes = 0;
00361         /* Setup the resident soft key stuff, a piece at a time */
00362         /* Upload what scripts we can for voicemail ahead of time */
00363         bytes += ast_adsi_download_disconnect(buf + bytes);
00364    if (ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DOWNLOAD, 0))
00365       return -1;
00366    return 0;
00367 }

int ast_adsi_get_cpeid struct ast_channel chan,
unsigned char *  cpeid,
int  voice
 

Returns 1 on success, storing 4 bytes of CPE ID at buf or -1 on hangup, or 0 if there was no hangup but it failed to find the device ID. Returns to voice mode if "voice" is non-zero.

Definition at line 628 of file res_adsi.c.

References ADSI_MSG_DISPLAY, ast_adsi_data_mode(), ast_adsi_query_cpeid(), ast_adsi_read_encoded_dtmf(), ast_adsi_transmit_message_full(), ast_adsi_voice_mode(), ast_log(), ast_waitfordigit(), and LOG_WARNING.

00629 {
00630    unsigned char buf[256];
00631    int bytes = 0;
00632    int res;
00633    bytes += ast_adsi_data_mode(buf);
00634    ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0);
00635 
00636    bytes = 0;
00637    bytes += ast_adsi_query_cpeid(buf);
00638    ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0);
00639 
00640    /* Get response */
00641    memset(buf, 0, sizeof(buf));
00642    res = ast_adsi_read_encoded_dtmf(chan, cpeid, 4);
00643    if (res != 4) {
00644       ast_log(LOG_WARNING, "Got %d bytes back of encoded DTMF, expecting 4\n", res);
00645       res = 0;
00646    } else {
00647       res = 1;
00648    }
00649 
00650    if (voice) {
00651       bytes = 0;
00652       bytes += ast_adsi_voice_mode(buf, 0);
00653       ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0);
00654       /* Ignore the resulting DTMF B announcing it's in voice mode */
00655       ast_waitfordigit(chan, 1000);
00656    }
00657    return res;
00658 }

int ast_adsi_get_cpeinfo struct ast_channel chan,
int *  width,
int *  height,
int *  buttons,
int  voice
 

Definition at line 660 of file res_adsi.c.

References ADSI_MSG_DISPLAY, ast_adsi_data_mode(), ast_adsi_query_cpeinfo(), ast_adsi_transmit_message_full(), ast_adsi_voice_mode(), ast_log(), ast_readstring(), ast_waitfordigit(), and LOG_WARNING.

00661 {
00662    unsigned char buf[256];
00663    int bytes = 0;
00664    int res;
00665    bytes += ast_adsi_data_mode(buf);
00666    ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0);
00667 
00668    bytes = 0;
00669    bytes += ast_adsi_query_cpeinfo(buf);
00670    ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0);
00671 
00672    /* Get width */
00673    memset(buf, 0, sizeof(buf));
00674    res = ast_readstring(chan, (char *)buf, 2, 1000, 500, "");
00675    if (res < 0)
00676       return res;
00677    if (strlen((char *)buf) != 2) {
00678       ast_log(LOG_WARNING, "Got %d bytes of width, expecting 2\n", res);
00679       res = 0;
00680    } else {
00681       res = 1;
00682    }
00683    if (width)
00684       *width = atoi((char *)buf);
00685    /* Get height */
00686    memset(buf, 0, sizeof(buf));
00687    if (res) {
00688       res = ast_readstring(chan, (char *)buf, 2, 1000, 500, "");
00689       if (res < 0)
00690          return res;
00691       if (strlen((char *)buf) != 2) {
00692          ast_log(LOG_WARNING, "Got %d bytes of height, expecting 2\n", res);
00693          res = 0;
00694       } else {
00695          res = 1;
00696       }  
00697       if (height)
00698          *height= atoi((char *)buf);
00699    }
00700    /* Get buttons */
00701    memset(buf, 0, sizeof(buf));
00702    if (res) {
00703       res = ast_readstring(chan, (char *)buf, 1, 1000, 500, "");
00704       if (res < 0)
00705          return res;
00706       if (strlen((char *)buf) != 1) {
00707          ast_log(LOG_WARNING, "Got %d bytes of buttons, expecting 1\n", res);
00708          res = 0;
00709       } else {
00710          res = 1;
00711       }  
00712       if (buttons)
00713          *buttons = atoi((char *)buf);
00714    }
00715    if (voice) {
00716       bytes = 0;
00717       bytes += ast_adsi_voice_mode(buf, 0);
00718       ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0);
00719       /* Ignore the resulting DTMF B announcing it's in voice mode */
00720       ast_waitfordigit(chan, 1000);
00721    }
00722    return res;
00723 }

int ast_adsi_input_control unsigned char *  buf,
int  page,
int  line,
int  display,
int  format,
int  just
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
page Which page to input on (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
line Line number to input on
display Set to zero to obscure input, or 1 to leave visible
format Format number to use (0-7)
just Justification (left, right center, indent)
Returns number of bytes added to buffer or -1 on error.

Definition at line 857 of file res_adsi.c.

References ADSI_INPUT_CONTROL.

00858 {
00859    int bytes=0;
00860 
00861    if (page) {
00862       if (line > 4) return -1;
00863    } else {
00864       if (line > 33) return -1;
00865    }
00866 
00867    if (line < 1)
00868       return -1;
00869 
00870    buf[bytes++] = ADSI_INPUT_CONTROL;
00871    bytes++;
00872    buf[bytes++] = ((page & 1) << 7) | (line & 0x3f);
00873    buf[bytes++] = ((display & 1) << 7) | ((just & 0x3) << 4) | (format & 0x7);
00874    
00875    buf[1] = bytes - 2;
00876    return bytes;
00877 
00878 }

int ast_adsi_input_format unsigned char *  buf,
int  num,
int  dir,
int  wrap,
char *  format1,
char *  format2
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
num Which format we are setting
dir Which direction (ADSI_DIR_FROM_LEFT or ADSI_DIR_FROM_RIGHT)
wrap Set to 1 to permit line wrap, or 0 if not
format1 Format for column 1
format2 Format for column 2
Returns number of bytes added to buffer or -1 on error.

Definition at line 880 of file res_adsi.c.

References ADSI_INPUT_FORMAT, and ccopy().

00881 {
00882    int bytes = 0;
00883 
00884    if (!strlen((char *)format1))
00885       return -1;
00886 
00887    buf[bytes++] = ADSI_INPUT_FORMAT;
00888    bytes++;
00889    buf[bytes++] = ((dir & 1) << 7) | ((wrap & 1) << 6) | (num & 0x7);
00890    bytes += ccopy(buf + bytes, (unsigned char *)format1, 20);
00891    buf[bytes++] = 0xff;
00892    if (format2 && strlen((char *)format2)) {
00893       bytes += ccopy(buf + bytes, (unsigned char *)format2, 20);
00894    }
00895    buf[1] = bytes - 2;
00896    return bytes;
00897 }

int ast_adsi_load_session struct ast_channel chan,
unsigned char *  app,
int  ver,
int  data
 

Parameters:
chan Channel to test for loaded app
app Four character app name (must be unique to your application)
ver optional version number
data Non-zero if you want to be put in data mode
Returns 0 if scripts is not loaded or not an ADSI CPE. Returns -1 on hangup. Returns 1 if script already loaded.

Definition at line 992 of file res_adsi.c.

References ADSI_MSG_DISPLAY, ast_adsi_connect_session(), ast_adsi_data_mode(), ast_adsi_transmit_message_full(), ast_log(), ast_readstring(), LOG_DEBUG, LOG_WARNING, and option_debug.

Referenced by adsi_announce_park().

00993 {
00994    unsigned char dsp[256];
00995    int bytes;
00996    int res;
00997    char resp[2];
00998 
00999    memset(dsp, 0, sizeof(dsp));
01000 
01001    /* Connect to session */
01002    bytes = 0;
01003    bytes += ast_adsi_connect_session(dsp + bytes, app, ver);
01004 
01005    if (data)
01006       bytes += ast_adsi_data_mode(dsp + bytes);
01007 
01008    /* Prepare key setup messages */
01009    if (ast_adsi_transmit_message_full(chan, dsp, bytes, ADSI_MSG_DISPLAY, 0))
01010       return -1;
01011    if (app) {
01012       res = ast_readstring(chan, resp, 1, 1200, 1200, "");
01013       if (res < 0)
01014          return -1;
01015       if (res) {
01016          if (option_debug)
01017             ast_log(LOG_DEBUG, "No response from CPE about version.  Assuming not there.\n");
01018          return 0;
01019       }
01020       if (!strcmp(resp, "B")) {
01021          if (option_debug)
01022             ast_log(LOG_DEBUG, "CPE has script '%s' version %d already loaded\n", app, ver);
01023          return 1;
01024       } else if (!strcmp(resp, "A")) {
01025          if (option_debug)
01026             ast_log(LOG_DEBUG, "CPE hasn't script '%s' version %d already loaded\n", app, ver);
01027       } else {
01028          ast_log(LOG_WARNING, "Unexpected CPE response to script query: %s\n", resp);
01029       }
01030    } else
01031       return 1;
01032    return 0;
01033 
01034 }

int ast_adsi_load_soft_key unsigned char *  buf,
int  key,
const char *  llabel,
const char *  slabel,
const char *  ret,
int  data
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
key Key code from 2 to 33, for which key we are loading
llabel Long label for key (1-18 bytes)
slabel Short label for key (1-7 bytes)
ret Optional return sequence (NULL for none)
data whether to put CPE in data mode before sending digits
Returns number of bytes added to buffer or -1 on error.

Definition at line 466 of file res_adsi.c.

References ADSI_LOAD_SOFTKEY, ADSI_SWITCH_TO_DATA2, and ccopy().

00467 {
00468    int bytes=0;
00469 
00470    /* Abort if invalid key specified */
00471    if ((key < 2) || (key > 33))
00472       return -1;
00473    buf[bytes++] = ADSI_LOAD_SOFTKEY;
00474    /* Reserve for length */
00475    bytes++;
00476    /* Which key */
00477    buf[bytes++] = key;
00478 
00479    /* Carefully copy long label */
00480    bytes += ccopy(buf + bytes, (const unsigned char *)llabel, 18);
00481 
00482    /* Place delimiter */
00483    buf[bytes++] = 0xff;
00484 
00485    /* Short label */
00486    bytes += ccopy(buf + bytes, (const unsigned char *)slabel, 7);
00487 
00488 
00489    /* If specified, copy return string */
00490    if (ret) {
00491       /* Place delimiter */
00492       buf[bytes++] = 0xff;
00493       if (data)
00494          buf[bytes++] = ADSI_SWITCH_TO_DATA2;
00495       /* Carefully copy return string */
00496       bytes += ccopy(buf + bytes, (const unsigned char *)ret, 20);
00497 
00498    }
00499    /* Replace parameter length */
00500    buf[1] = bytes - 2;
00501    return bytes;
00502    
00503 }

int ast_adsi_print struct ast_channel chan,
char **  lines,
int *  align,
int  voice
 

Parameters:
chan Channel to display on
lines NULL-terminated list of things to print (no more than 4 recommended)
align list of alignments to use (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CEN, etc..)
voice whether to jump into voice mode when finished
Return 0 on success (or adsi unavailable) and -1 on hangup

Definition at line 972 of file res_adsi.c.

References ADSI_INFO_PAGE, ADSI_MSG_DISPLAY, ast_adsi_display(), ast_adsi_set_line(), ast_adsi_transmit_message_full(), ast_adsi_voice_mode(), and ast_waitfordigit().

Referenced by adsi_announce_park().

00973 {
00974    unsigned char buf[4096];
00975    int bytes=0;
00976    int res;
00977    int x;
00978    for(x=0;lines[x];x++) 
00979       bytes += ast_adsi_display(buf + bytes, ADSI_INFO_PAGE, x+1, aligns[x], 0, lines[x], "");
00980    bytes += ast_adsi_set_line(buf + bytes, ADSI_INFO_PAGE, 1);
00981    if (voice) {
00982       bytes += ast_adsi_voice_mode(buf + bytes, 0);
00983    }
00984    res = ast_adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0);
00985    if (voice) {
00986       /* Ignore the resulting DTMF B announcing it's in voice mode */
00987       ast_waitfordigit(chan, 1000);
00988    }
00989    return res;
00990 }

int ast_adsi_query_cpeid unsigned char *  buf  ) 
 

Returns number of bytes added to message

Definition at line 573 of file res_adsi.c.

References ADSI_QUERY_CPEID.

Referenced by ast_adsi_get_cpeid().

00574 {
00575    int bytes = 0;
00576    buf[bytes++] = ADSI_QUERY_CPEID;
00577    /* Reserve space for length */
00578    bytes++;
00579    buf[1] = bytes - 2;
00580    return bytes;
00581 }

int ast_adsi_query_cpeinfo unsigned char *  buf  ) 
 

Definition at line 583 of file res_adsi.c.

References ADSI_QUERY_CONFIG.

Referenced by ast_adsi_get_cpeinfo().

00584 {
00585    int bytes = 0;
00586    buf[bytes++] = ADSI_QUERY_CONFIG;
00587    /* Reserve space for length */
00588    bytes++;
00589    buf[1] = bytes - 2;
00590    return bytes;
00591 }

int ast_adsi_read_encoded_dtmf struct ast_channel chan,
unsigned char *  buf,
int  maxlen
 

Returns number of bytes received

Definition at line 593 of file res_adsi.c.

References ast_waitfordigit().

Referenced by ast_adsi_get_cpeid().

00594 {
00595    int bytes = 0;
00596    int res;
00597    unsigned char current = 0;
00598    int gotstar = 0;
00599    int pos = 0;
00600    memset(buf, 0, sizeof(buf));
00601    while(bytes <= maxlen) {
00602       /* Wait up to a second for a digit */
00603       res = ast_waitfordigit(chan, 1000);
00604       if (!res)
00605          break;
00606       if (res == '*') {
00607          gotstar = 1;   
00608          continue;
00609       }
00610       /* Ignore anything other than a digit */
00611       if ((res < '0') || (res > '9'))
00612          continue;
00613       res -= '0';
00614       if (gotstar)
00615          res += 9;
00616       if (pos)  {
00617          pos = 0;
00618          buf[bytes++] = (res << 4) | current;
00619       } else {
00620          pos = 1;
00621          current = res;
00622       }
00623       gotstar = 0;
00624    }
00625    return bytes;
00626 }

int ast_adsi_set_keys unsigned char *  buf,
unsigned char *  keys
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
keys Array of 8 unsigned chars with the key numbers, may be OR'd with ADSI_KEY_HILITE But remember, the last two keys aren't real keys, they're for scrolling
Returns number of bytes added to buffer or -1 on error.

Definition at line 899 of file res_adsi.c.

References ADSI_INIT_SOFTKEY_LINE.

Referenced by ast_adsi_channel_restore().

00900 {
00901    int bytes=0;
00902    int x;
00903    /* Message type */
00904    buf[bytes++] = ADSI_INIT_SOFTKEY_LINE;
00905    /* Space for size */
00906    bytes++;
00907    /* Key definitions */
00908    for (x=0;x<6;x++)
00909       buf[bytes++] = (keys[x] & 0x3f) ? keys[x] : (keys[x] | 0x1);
00910    buf[1] = bytes - 2;
00911    return bytes;
00912 }

int ast_adsi_set_line unsigned char *  buf,
int  page,
int  line
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
page Which page (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
line Line number (1-33 for info page, 1-4 for comm page)
Returns number of bytes added to buffer or -1 on error.

Definition at line 914 of file res_adsi.c.

References ADSI_LINE_CONTROL.

Referenced by ast_adsi_channel_restore(), and ast_adsi_print().

00915 {
00916    int bytes=0;
00917 
00918    /* Sanity check line number */
00919 
00920    if (page) {
00921       if (line > 4) return -1;
00922    } else {
00923       if (line > 33) return -1;
00924    }
00925 
00926    if (line < 1)
00927       return -1;
00928    /* Parameter type */
00929    buf[bytes++] = ADSI_LINE_CONTROL;
00930    
00931    /* Reserve space for size */
00932    bytes++;
00933 
00934    /* Page and line */
00935    buf[bytes++] = ((page & 0x1) << 7) | (line & 0x3f);
00936 
00937    buf[1] = bytes - 2;
00938    return bytes;
00939 
00940 };

int ast_adsi_transmit_message struct ast_channel chan,
unsigned char *  msg,
int  msglen,
int  msgtype
 

Definition at line 450 of file res_adsi.c.

References ast_adsi_transmit_message_full().

00451 {
00452    return ast_adsi_transmit_message_full(chan, msg, msglen, msgtype, 1);
00453 }

int ast_adsi_transmit_message_full struct ast_channel chan,
unsigned char *  msg,
int  msglen,
int  msgtype,
int  dowait
 

Definition at line 369 of file res_adsi.c.

References __adsi_transmit_messages(), ADSI_FLAG_DATAMODE, ADSI_SWITCH_TO_DATA, ADSI_SWITCH_TO_VOICE, ast_channel::adsicpe, AST_FORMAT_ULAW, ast_log(), ast_safe_sleep(), ast_set_read_format(), ast_set_write_format(), ast_stopstream(), ast_waitfordigit(), LOG_WARNING, option_debug, ast_channel::readformat, and ast_channel::writeformat.

Referenced by ast_adsi_begin_download(), ast_adsi_end_download(), ast_adsi_get_cpeid(), ast_adsi_get_cpeinfo(), ast_adsi_load_session(), ast_adsi_print(), ast_adsi_transmit_message(), and ast_adsi_unload_session().

00370 {
00371    unsigned char *msgs[5] = { NULL, NULL, NULL, NULL, NULL };
00372    int msglens[5];
00373    int msgtypes[5];
00374    int newdatamode;
00375    int res;
00376    int x;
00377    int writeformat, readformat;
00378    int waitforswitch = 0;
00379 
00380    writeformat = chan->writeformat;
00381    readformat = chan->readformat;
00382 
00383    newdatamode = chan->adsicpe & ADSI_FLAG_DATAMODE;
00384 
00385    for (x=0;x<msglen;x+=(msg[x+1]+2)) {
00386       if (msg[x] == ADSI_SWITCH_TO_DATA) {
00387          if (option_debug)
00388             ast_log(LOG_DEBUG, "Switch to data is sent!\n");
00389          waitforswitch++;
00390          newdatamode = ADSI_FLAG_DATAMODE;
00391       }
00392       
00393       if (msg[x] == ADSI_SWITCH_TO_VOICE) {
00394          if (option_debug)
00395             ast_log(LOG_DEBUG, "Switch to voice is sent!\n");
00396          waitforswitch++;
00397          newdatamode = 0;
00398       }
00399    }
00400    msgs[0] = msg;
00401 
00402    msglens[0] = msglen;
00403    msgtypes[0] = msgtype;
00404 
00405    if (msglen > 253) {
00406       ast_log(LOG_WARNING, "Can't send ADSI message of %d bytes, too large\n", msglen);
00407       return -1;
00408    }
00409 
00410    ast_stopstream(chan);
00411 
00412    if (ast_set_write_format(chan, AST_FORMAT_ULAW)) {
00413       ast_log(LOG_WARNING, "Unable to set write format to ULAW\n");
00414       return -1;
00415    }
00416 
00417    if (ast_set_read_format(chan, AST_FORMAT_ULAW)) {
00418       ast_log(LOG_WARNING, "Unable to set read format to ULAW\n");
00419       if (writeformat) {
00420          if (ast_set_write_format(chan, writeformat)) 
00421             ast_log(LOG_WARNING, "Unable to restore write format to %d\n", writeformat);
00422       }
00423       return -1;
00424    }
00425    res = __adsi_transmit_messages(chan, msgs, msglens, msgtypes);
00426 
00427    if (dowait) {
00428       if (option_debug)
00429          ast_log(LOG_DEBUG, "Wait for switch is '%d'\n", waitforswitch);
00430       while (waitforswitch-- && ((res = ast_waitfordigit(chan, 1000)) > 0)) { 
00431          res = 0; 
00432          if (option_debug)
00433             ast_log(LOG_DEBUG, "Waiting for 'B'...\n");
00434       }
00435    }
00436    
00437    if (!res)
00438       chan->adsicpe = (chan->adsicpe & ~ADSI_FLAG_DATAMODE) | newdatamode;
00439 
00440    if (writeformat)
00441       ast_set_write_format(chan, writeformat);
00442    if (readformat)
00443       ast_set_read_format(chan, readformat);
00444 
00445    if (!res)
00446       res = ast_safe_sleep(chan, 100 );
00447    return res;
00448 }

int ast_adsi_transmit_messages struct ast_channel chan,
unsigned char **  msg,
int *  msglen,
int *  msgtype
 

int ast_adsi_unload_session struct ast_channel chan  ) 
 

Definition at line 1036 of file res_adsi.c.

References ADSI_MSG_DISPLAY, ast_adsi_disconnect_session(), ast_adsi_transmit_message_full(), and ast_adsi_voice_mode().

01037 {
01038    unsigned char dsp[256];
01039    int bytes;
01040 
01041    memset(dsp, 0, sizeof(dsp));
01042 
01043    /* Connect to session */
01044    bytes = 0;
01045    bytes += ast_adsi_disconnect_session(dsp + bytes);
01046    bytes += ast_adsi_voice_mode(dsp + bytes, 0);
01047 
01048    /* Prepare key setup messages */
01049    if (ast_adsi_transmit_message_full(chan, dsp, bytes, ADSI_MSG_DISPLAY, 0))
01050       return -1;
01051    return 0;
01052 }

int ast_adsi_voice_mode unsigned char *  buf,
int  when
 

Parameters:
buf Character buffer to create parameter in (must have at least 256 free)
when (a time in seconds) to make the switch
Returns number of bytes added to buffer or -1 on error.

Definition at line 770 of file res_adsi.c.

References ADSI_SWITCH_TO_VOICE.

Referenced by ast_adsi_get_cpeid(), ast_adsi_get_cpeinfo(), ast_adsi_print(), and ast_adsi_unload_session().

00771 {
00772    int bytes=0;
00773 
00774    /* Message type */
00775    buf[bytes++] = ADSI_SWITCH_TO_VOICE;
00776 
00777    /* Reserve space for length */
00778    bytes++;
00779 
00780    buf[bytes++] = when & 0x7f;
00781 
00782    buf[1] = bytes - 2;
00783    return bytes;
00784 
00785 }


Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen