Maxim Integrated 73M1866B/73M1966B FXOAPI - Manual (Page 30)

73M1866B/73M1966B FXOAPI User Guide UG_1x66B_046
30 Rev. 2.1
2.11 1x66 H/W Register Access and Debugging aid APIs
2.11.1 M1x66_HWRegisterRead
Description
Perform H/W register reading from the 73M1x66B device that carries the FXO channel. This API is not
recommended for use in normal operation but only for diagnostic or testing purpose.
The channel handle contains the corresponding SPI channel ID (cid) of the 73M1x66B device in the daisy
chain. This SPI cid is passed to the driver to retrieve the value of the specified register.
Prototype
M1x66_RET M1x66_HWRegisterRead (
M1x66_HANDLE channel,
M1x66_REG register,
char *pRetData );
Parameters
Data Type Name Description
M1x66_HANDLE channel Channel handle from FXO open channel.
M1x66_REG_TYPE Register 1x66 Register
char *pRetData Pointer to a single byte of returned data.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successfully read the register.
M1x66_FAILED – Failure.
2.11.2 M1x66_HWRegisterReadAll
Description
This API is similar to the 1x66 H/W Register Access and Debugging aid APIs
M1x66_HWRegisterRead, but all 73M1x66B 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 0x25 bytes buffer is required to store all returned register where the
first byte corresponds to the first register (RG00) and so on.
Prototype
M1x66_RET M1x66_HWRegisterReadAll (
M1x66_HANDLE channel,
char *pRetData );
Parameters
Data Type Name Description
M1x66_HANDLE channel Channel handle from FXO open channel.
char *pRetData Pointer to return data for all 0x25 (byte) registers.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successfully read all registers.