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

UG_1x22_055 73M1822/73M1922 Modem API User Guide
Rev. 1.0 13
2.10 M1X22_HWRegisterRead
Description
Perform H/W register reading from the 73M1x22 device that carries the channel. This API is not
recommended for use in normal operation but only for diagnostic or testing purpose.
Prototype
M1X22_RET M1X22_HWRegisterRead (
M1X22_HANDLE channel,
M1X22_REG_TYPE register,
char *pRetData );
Parameters
Data Type Name Description
M1X22_HANDLE channel Channel handle from open channel.
M1X22_REG_TYPE register 1x22 register.
char *pRetData Pointer to a single byte of returned data.
Return Values
Data Type Description
M1X22_RET M1X22_SUCCESS – Successfully read the register.
M1X22_FAILED – Failure.
2.11 M1X22_HWRegisterReadAll
Description
This API is similar to the M1X22_HWRegisterRead, but all 73M1x22 registers will be read. The register
contents will be returned via the pRetData. It is the responsibility of the caller application to insure that
this data pointer contains enough space for the return data. A 0x20 bytes buffer is required to store all
returned register where the first byte corresponds to the first register (RG00) and so on.
Prototype
M1X22_RET M1X22_HWRegisterReadAll (
M1X22_HANDLE channel,
char *pRetData );
Parameters
Data Type Name Description
M1X22_HANDLE channel Channel handle from open channel.
char *pRetData Pointer to return data for all 0x20 (byte) registers.
Return Values
Data Type Description
M1X22_RET M1X22_SUCCESS – Successfully read all registers.
M1X22_FAILED – Failure.