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

73M1822/73M1922 Modem API User Guide UG_1x22_055
16 Rev. 1.0
2.16 M1X22_GetFileDescriptor
Description
To provide full flexibility to the driver access, this API can be called by an application program to obtain
the file descriptor for a given device or channel handle. With this returned file descriptor, the user has
direct access to the driver via its native IOCTL as described in the 73M1822/73M1922 Control Module
User Guide.
Caution: Accessing directly to the driver via IOCTL in mix mode with API is generally not recommended.
However, if this becomes necessary it is strongly advised that the user carefully review the API
implementation and be aware of any potential conflicts that may exist as a result of this change.
Prototype
int M1X22_GetFileDescriptor (M1X22_HANDLE pHandle);
Parameters
Data Type Name Description
M1X22_HANDLE pHandle Device or channel handle obtains from open API.
Return Values
Data Type Description
int Device or channel file descriptor.
A NULL value indicates invalid, or not opened file descriptor.
2.17 M1X22_GetCurrentIET
Description
Read the line current IET table entry.
Prototype
int M1X22_GetCurrentIET (
M1X22_HANDLE channel,
unsigned int ietIndex,
M1X22_IET_t *pIET );
Parameters
Data Type Name Description
M1X22_HANDLE channel Channel handle obtained from open channel.
unsigned int ietIndex IET entry index – row number (0 – 9).
M1X22_IET_t *pIET Pointer to an output structure M1X22_IET_t.
Return Values
Data Type Description
M1X22_RET M1X22_SUCCESS – Successfully read the IET entry.
M1X22_FAILED – Failure.