Maxim Integrated 73M1822/73M1922 Modem API - Manual (Page 23)

UG_1x22_055 73M1822/73M1922 Modem API User Guide
Rev. 1.0 23
3 Structure Reference
This section contains the detail description of the data structure used in this API subsystem. Table 2
contains the summary of the reference structure.
Table 2: Structure Overview
Name Description
M1X22_HANDLE Device or Channel handle.
M1X22_CHAN_INIT Channel Init structure.
3.1 M1X22_HANDLE
Description
The device or channel handle is a pointer to a device or channel control data structure where information
pertaining to device or channel is being kept. This control data structure is created when the device or
channel is opened and is used by the API internal subsystem to indentify the device or channel until it is
closed.
Prototype
/*
**************************************************************************
** Device/Channel Control block
*************************************************************************/
typedef struct {
int chanNum;
int fd;
void (*eventCallback)(M1X22_EVENT_ID,
unsigned int,
unsigned int,
unsigned int,
unsigned int,
unsigned int);
int initialized;
}
m1X22_DevChanHandle;
/* Device or channel handle */
typedef m1X22_DevChanHandle *M1X22_HANDLE;
Parameters
Data Type Name Description
int chanNum Device or channel number.
int fd Device or channel corresponding file descriptor.
void (*eventCallback)() An event callback function pointer, used only for device.
int initialized Initialization flag.