PI3EQX12908A2 1.0.1
This library is a software library that works with the I2C mode of the PI3EQX12908 PCIe 3.0 redriver chip. This library provides a convenient and efficient way to access the I2C interfaces of the chip, allowing developers to easily integrate the redriver into their systems.
Loading...
Searching...
No Matches
PI3EQX12908 Class Reference

Class that stores state and functions for interacting with PI3EQX12908A2. More...

#include <PI3EQX12908A2.h>

Public Member Functions

 init (uint8_t i2c_addr)
 Initialize the PI3EQX12908 object This function sets the I2C address and the register names.
 
uint8_t getSignalDetect ()
 Gets the signal detect register This function reads the signal detect register values.
 
uint8_t getSignalDetect_A ()
 Gets the signal detect of A channel This function reads the signal detect register and returns the channel A status.
 
uint8_t getSignalDetect_A (uint8_t index)
 Gets the signal detect A by channel index This function reads the signal detect register value and returns the status of given channel index of A channel.
 
uint8_t getSignalDetect_B ()
 Gets the signal detect of B channel This function reads the signal detect register and returns the channel B status.
 
uint8_t getSignalDetect_B (uint8_t index)
 Gets the signal detect B by channel index This function reads the signal detect register value and returns the status of given channel index of B channel.
 
uint8_t getRxDetect ()
 Gets the RX detect register This function reads the RX detect register values.
 
uint8_t getRxDetect_A ()
 Gets the RX detect of A channel This function reads the RX detect register and returns the channel A status.
 
uint8_t getRxDetect_A (uint8_t index)
 Gets the RX detect A by channel index This function reads the RX detect register value and returns the status of given channel index of A channel.
 
uint8_t getRxDetect_B ()
 Gets the RX detect of B channel This function reads the RX detect register and returns the channel B status.
 
uint8_t getRxDetect_B (uint8_t index)
 Gets the RX detect B by channel index This function reads the RX detect register value and returns the status of given channel index of B channel.
 
uint8_t getPowerDown ()
 Gets the power down register This function reads the power down register values.
 
uint8_t getPowerDown_A ()
 Gets the power down of A channel This function reads the power down register and returns the channel A status.
 
uint8_t getPowerDown_A (uint8_t index)
 Gets the power down A by channel index This function reads the power down register value and returns the status of given channel index of A channel.
 
uint8_t getPowerDown_B ()
 Gets the power down of B channel This function reads the power down register and returns the channel B status.
 
uint8_t getPowerDown_B (uint8_t index)
 Gets the power down B by channel index This function reads the power down register value and returns the status of given channel index of B channel.
 
void setPowerDown (uint8_t isDown)
 Sets the power down register. This function change the power down status of all channels.
 
void setPowerDown_A (uint8_t isDown)
 Sets the power down of A channel. This function change the power down status of channel A.
 
void setPowerDown_A (uint8_t index, uint8_t isDown)
 Sets the power down of a given index of A channel. This function change the power down status of the given channel A index.
 
void setPowerDown_B (uint8_t isDown)
 Sets the power down of B channel. This function change the power down status of channel B.
 
void setPowerDown_B (uint8_t index, uint8_t isDown)
 Sets the power down of a given index of B channel. This function change the power down status of the given channel B index.
 
uint8_t getConfig_A0 ()
 Gets the configuration of the 0 index A channel. This function reads the configuration of the 0 index A channel value.
 
uint8_t getEQ_A0 ()
 Gets the equalizer configuration of the 0 index A channel. This function reads the equalizer value of the 0 index A channel value.
 
uint8_t getFlatGain_A0 ()
 Gets the flat gain configuration of the 0 index A channel. This function reads the flat gain value of the 0 index A channel value.
 
uint8_t getSW_A0 ()
 Gets the swing configuration of the 0 index A channel. This function reads the swing value of the 0 index A channel value.
 
void setConfig_A0 (uint8_t config)
 Sets the configuration of the 0 index A channel. This function sets the configuration register of A0. NOT RECOMENDED TO USE! **.
 
void setEQ_A0 (uint8_t EQ)
 Sets the equalizer value of the 0 index A channel. This function sets the equalizer value of A0.
 
void setFlatGain_A0 (uint8_t flat_gain)
 Sets the flat gain value of the 0 index A channel. This function sets the flat gain value of A0.
 
void setSW_A0 (uint8_t swing)
 Sets the swing value of the 0 index A channel. This function sets the swing value of A0.
 
uint8_t getConfig_A1 ()
 Gets the configuration of the 1 index A channel. This function reads the configuration of the 1 index A channel value.
 
uint8_t getEQ_A1 ()
 Gets the equalizer configuration of the 1 index A channel. This function reads the equalizer value of the 1 index A channel value.
 
uint8_t getFlatGain_A1 ()
 Gets the flat gain configuration of the 1 index A channel. This function reads the flat gain value of the 1 index A channel value.
 
uint8_t getSW_A1 ()
 Gets the swing configuration of the 1 index A channel. This function reads the swing value of the 1 index A channel value.
 
void setConfig_A1 (uint8_t config)
 Sets the configuration of the 1 index A channel. This function sets the configuration register of A1. NOT RECOMENDED TO USE! **.
 
void setEQ_A1 (uint8_t EQ)
 Sets the equalizer value of the 1 index A channel. This function sets the equalizer value of A1.
 
void setFlatGain_A1 (uint8_t flat_gain)
 Sets the flat gain value of the 1 index A channel. This function sets the flat gain value of A1.
 
void setSW_A1 (uint8_t swing)
 Sets the swing value of the 1 index A channel. This function sets the swing value of A1.
 
uint8_t getConfig_A2 ()
 Gets the configuration of the 2 index A channel. This function reads the configuration of the 2 index A channel value.
 
uint8_t getEQ_A2 ()
 Gets the equalizer configuration of the 2 index A channel. This function reads the equalizer value of the 2 index A channel value.
 
uint8_t getFlatGain_A2 ()
 Gets the flat gain configuration of the 2 index A channel. This function reads the flat gain value of the 2 index A channel value.
 
uint8_t getSW_A2 ()
 Gets the swing configuration of the 2 index A channel. This function reads the swing value of the 2 index A channel value.
 
void setConfig_A2 (uint8_t config)
 Sets the configuration of the 2 index A channel. This function sets the configuration register of A2. NOT RECOMENDED TO USE! **.
 
void setEQ_A2 (uint8_t EQ)
 Sets the equalizer value of the 2 index A channel. This function sets the equalizer value of A2.
 
void setFlatGain_A2 (uint8_t flat_gain)
 Sets the flat gain value of the 2 index A channel. This function sets the flat gain value of A2.
 
void setSW_A2 (uint8_t swing)
 Sets the swing value of the 2 index A channel. This function sets the swing value of A2.
 
uint8_t getConfig_A3 ()
 Gets the configuration of the 3 index A channel. This function reads the configuration of the 3 index A channel value.
 
uint8_t getEQ_A3 ()
 Gets the equalizer configuration of the 3 index A channel. This function reads the equalizer value of the 3 index A channel value.
 
uint8_t getFlatGain_A3 ()
 Gets the flat gain configuration of the 3 index A channel. This function reads the flat gain value of the 3 index A channel value.
 
uint8_t getSW_A3 ()
 Gets the swing configuration of the 3 index A channel. This function reads the swing value of the 3 index A channel value.
 
void setConfig_A3 (uint8_t config)
 Sets the configuration of the 3 index A channel. This function sets the configuration register of A3. NOT RECOMENDED TO USE! **.
 
void setEQ_A3 (uint8_t EQ)
 Sets the equalizer value of the 3 index A channel. This function sets the equalizer value of A3.
 
void setFlatGain_A3 (uint8_t flat_gain)
 Sets the flat gain value of the 3 index A channel. This function sets the flat gain value of A3.
 
void setSW_A3 (uint8_t swing)
 Sets the swing value of the 3 index A channel. This function sets the swing value of A3.
 
uint8_t getConfig_B0 ()
 Gets the configuration of the 0 index B channel. This function reads the configuration of the 0 index B channel value.
 
uint8_t getEQ_B0 ()
 Gets the equalizer configuration of the 0 index B channel. This function reads the equalizer value of the 0 index B channel value.
 
uint8_t getFlatGain_B0 ()
 Gets the flat gain configuration of the 0 index B channel. This function reads the flat gain value of the 0 index B channel value.
 
uint8_t getSW_B0 ()
 Gets the swing configuration of the 0 index B channel. This function reads the swing value of the 0 index B channel value.
 
void setConfig_B0 (uint8_t config)
 Sets the configuration of the 0 index B channel. This function sets the configuration register of B0. NOT RECOMENDED TO USE! **.
 
void setEQ_B0 (uint8_t EQ)
 Sets the equalizer value of the 0 index B channel. This function sets the equalizer value of B0.
 
void setFlatGain_B0 (uint8_t flat_gain)
 Sets the flat gain value of the 0 index B channel. This function sets the flat gain value of B0.
 
void setSW_B0 (uint8_t swing)
 Sets the swing value of the 0 index B channel. This function sets the swing value of B0.
 
uint8_t getConfig_B1 ()
 Gets the configuration of the 1 index B channel. This function reads the configuration of the 1 index B channel value.
 
uint8_t getEQ_B1 ()
 Gets the equalizer configuration of the 1 index B channel. This function reads the equalizer value of the 1 index B channel value.
 
uint8_t getFlatGain_B1 ()
 Gets the flat gain configuration of the 1 index B channel. This function reads the flat gain value of the 1 index B channel value.
 
uint8_t getSW_B1 ()
 Gets the swing configuration of the 1 index B channel. This function reads the swing value of the 1 index B channel value.
 
void setConfig_B1 (uint8_t config)
 Sets the configuration of the 1 index B channel. This function sets the configuration register of B1. NOT RECOMENDED TO USE! **.
 
void setEQ_B1 (uint8_t EQ)
 Sets the equalizer value of the 1 index B channel. This function sets the equalizer value of B1.
 
void setFlatGain_B1 (uint8_t flat_gain)
 Sets the flat gain value of the 1 index B channel. This function sets the flat gain value of B1.
 
void setSW_B1 (uint8_t swing)
 Sets the swing value of the 1 index B channel. This function sets the swing value of B1.
 
uint8_t getConfig_B2 ()
 Gets the configuration of the 2 index B channel. This function reads the configuration of the 2 index B channel value.
 
uint8_t getEQ_B2 ()
 Gets the equalizer configuration of the 2 index B channel. This function reads the equalizer value of the 2 index B channel value.
 
uint8_t getFlatGain_B2 ()
 Gets the flat gain configuration of the 2 index B channel. This function reads the flat gain value of the 2 index B channel value.
 
uint8_t getSW_B2 ()
 Gets the swing configuration of the 2 index B channel. This function reads the swing value of the 2 index B channel value.
 
void setConfig_B2 (uint8_t config)
 Sets the configuration of the 2 index B channel. This function sets the configuration register of B2. NOT RECOMENDED TO USE! **.
 
void setEQ_B2 (uint8_t EQ)
 Sets the equalizer value of the 2 index B channel. This function sets the equalizer value of B2.
 
void setFlatGain_B2 (uint8_t flat_gain)
 Sets the flat gain value of the 2 index B channel. This function sets the flat gain value of B2.
 
void setSW_B2 (uint8_t swing)
 Sets the swing value of the 2 index B channel. This function sets the swing value of B2.
 
uint8_t getConfig_B3 ()
 Gets the configuration of the 3 index B channel. This function reads the configuration of the 3 index B channel value.
 
uint8_t getEQ_B3 ()
 Gets the equalizer configuration of the 3 index B channel. This function reads the equalizer value of the 3 index B channel value.
 
uint8_t getFlatGain_B3 ()
 Gets the flat gain configuration of the 3 index B channel. This function reads the flat gain value of the 3 index B channel value.
 
uint8_t getSW_B3 ()
 Gets the swing configuration of the 3 index B channel. This function reads the swing value of the 3 index B channel value.
 
void setConfig_B3 (uint8_t config)
 Sets the configuration of the 3 index B channel. This function sets the configuration register of B3. NOT RECOMENDED TO USE! **.
 
void setEQ_B3 (uint8_t EQ)
 Sets the equalizer value of the 3 index B channel. This function sets the equalizer value of B3.
 
void setFlatGain_B3 (uint8_t flat_gain)
 Sets the flat gain value of the 3 index B channel. This function sets the flat gain value of B3.
 
void setSW_B3 (uint8_t swing)
 Sets the swing value of the 3 index B channel. This function sets the swing value of B3.
 
uint8_t getSignalDetectConfig ()
 Gets the signal detect configuration register This function reads the signal detect configuration register values.
 
uint8_t getSignalDetectConfig_A ()
 Gets the signal detect configuration of A channel This function reads the signal detect configuration register and returns the channel A status.
 
uint8_t getSignalDetectConfig_A (uint8_t index)
 Gets the signal detect configuration A by channel index This function reads the signal detect configuration register value.
 
uint8_t getSignalDetectConfig_B ()
 Gets the signal detect configuration of B channel This function reads the signal detect configuration register and returns the channel B status.
 
uint8_t getSignalDetectConfig_B (uint8_t index)
 Gets the signal detect configuration B by channel index This function reads the signal detect configuration register value.
 
void setSignalDetectConfig (uint8_t isDown)
 Sets the signal detect configuration register. This function change the signal detect configuration of all channels.
 
void setSignalDetectConfig_A (uint8_t isDown)
 Sets the signal detect configuration of A channel. This function change the signal detect configuration of channel A.
 
void setSignalDetectConfig_A (uint8_t index, uint8_t isDown)
 Sets the signal detect configuration of a given index of A channel. This function change the signal detect configuration of the given channel A index.
 
void setSignalDetectConfig_B (uint8_t isDown)
 Sets the signal detect configuration of B channel. This function change the signal detect configuration of channel B.
 
void setSignalDetectConfig_B (uint8_t index, uint8_t isDown)
 Sets the signal detect configuration of a given index of B channel. This function change the signal detect configuration of the given channel B index.
 
uint8_t getRxDetectConfig ()
 Gets the RX detect configuration register This function reads the RX detect configuration register values.
 
uint8_t getRxDetectConfig_A ()
 Gets the RX detect configuration of A channel This function reads the RX detect configuration register and returns the channel A status.
 
uint8_t getRxDetectConfig_A (uint8_t index)
 Gets the RX detect configuration A by channel index This function reads the RX detect configuration register value.
 
uint8_t getRxDetectConfig_B ()
 Gets the RX detect configuration of B channel This function reads the RX detect configuration register and returns the channel B status.
 
uint8_t getRxDetectConfig_B (uint8_t index)
 Gets the RX detect configuration B by channel index This function reads the RX detect configuration register value.
 
void setRxDetectConfig (uint8_t isDown)
 Sets the RX detect configuration register. This function change the RX detect configuration of all channels.
 
void setRxDetectConfig_A (uint8_t isDown)
 Sets the RX detect configuration of A channel. This function change the RX detect configuration of channel A.
 
void setRxDetectConfig_A (uint8_t index, uint8_t isDown)
 Sets the RX detect configuration of a given index of A channel. This function change the RX detect configuration of the given channel A index.
 
void setRxDetectConfig_B (uint8_t isDown)
 Sets the RX detect configuration of B channel. This function change the RX detect configuration of channel B.
 
void setRxDetectConfig_B (uint8_t index, uint8_t isDown)
 Sets the RX detect configuration of a given index of B channel. This function change the RX detect configuration of the given channel B index.
 
uint8_t getSDTConfig ()
 Gets the signal detect threshold of all channels. This function gets the signal detect threshold of all channels.
 
uint8_t setSDTConfig (uint8_t thresh)
 Sets the signal detect threshold for all channels. This function changes the signal detect threshold of all channels.
 
void setConfig_A (uint8_t config)
 Sets the configuration of the channel A This function sets the configuration of channel A. NOT RECOMENDED TO USE! **.
 
void setConfig_A (uint8_t index, uint8_t config)
 Sets the configuration of the given index of channel A This function sets the configuration of the given index of channel A. This function is equal to setConfig_Ax(...) (x is channel index) NOT RECOMENDED TO USE! **.
 
void setConfig_B (uint8_t config)
 Sets the configuration of the channel A This function sets the configuration of channel A. NOT RECOMENDED TO USE! **.
 
void setConfig_B (uint8_t index, uint8_t config)
 Sets the configuration of the given index of channel B This function sets the configuration of the given index of channel B. This function is equal to setConfig_Bx(...) (x is channel index) NOT RECOMENDED TO USE! **.
 
void setConfig (uint8_t config)
 Sets the configuration of all channels This function sets the configuration of all channels. NOT RECOMENDED TO USE! **.
 
void setEQ_A (uint8_t EQ)
 Sets the equalizer of the channel A This function sets the equalizer settings of the channel A.
 
void setEQ_B (uint8_t EQ)
 Sets the equalizer of the channel B This function sets the equalizer settings of the channel B.
 
void setEQ (uint8_t EQ)
 Sets the equalizer of the all channels This function sets the equalizer settings of the all channels.
 
void setFG_A (uint8_t flat_gain)
 Sets the flat gain of the channel A This function sets the flat gain setting of the channel A.
 
void setFG_B (uint8_t flat_gain)
 Sets the flat gain of the channel B This function sets the flat gain setting of the channel B.
 
void setFG (uint8_t flat_gain)
 Sets the flat gain of all channels This function sets the flat gain setting of all channels.
 
void setSW_A (uint8_t swing)
 Sets the swing value of the channel A This function sets the swing value of the channel A.
 
void setSW_B (uint8_t swing)
 Sets the swing value of the channel B This function sets the swing value of the channel B.
 
void setSW (uint8_t swing)
 Sets the swing value of all channels This function sets the swing value of all channels.
 
void print_all ()
 Prints all of the registers This function prints all of the registers of the chip over the default UART (Serial)
 
void dump_all (uint8_t *data)
 Reads all of the registers This function reads all of the registers of the chip.
 

Detailed Description

Class that stores state and functions for interacting with PI3EQX12908A2.

Member Function Documentation

◆ init()

init ( uint8_t i2c_addr)

Initialize the PI3EQX12908 object This function sets the I2C address and the register names.

Parameters
i2c_addrThe 7 bit I2C address of the redriver.

◆ getSignalDetect()

uint8_t getSignalDetect ( )

Gets the signal detect register This function reads the signal detect register values.

Returns
8 bit value of signal detect register.

◆ getSignalDetect_A() [1/2]

uint8_t getSignalDetect_A ( )

Gets the signal detect of A channel This function reads the signal detect register and returns the channel A status.

Returns
4 bit value of channel A signal detect.

◆ getSignalDetect_A() [2/2]

uint8_t getSignalDetect_A ( uint8_t index)

Gets the signal detect A by channel index This function reads the signal detect register value and returns the status of given channel index of A channel.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
Returns
return zero for not detected, otherwise for detected.

◆ getSignalDetect_B() [1/2]

uint8_t getSignalDetect_B ( )

Gets the signal detect of B channel This function reads the signal detect register and returns the channel B status.

Returns
4 bit value of channel B signal detect.

◆ getSignalDetect_B() [2/2]

uint8_t getSignalDetect_B ( uint8_t index)

Gets the signal detect B by channel index This function reads the signal detect register value and returns the status of given channel index of B channel.

Parameters
indexA reference to the channel index of B channel from 0 to 3.
Returns
return zero for not detected, otherwise for detected.

◆ getRxDetect()

uint8_t getRxDetect ( )

Gets the RX detect register This function reads the RX detect register values.

Returns
8 bit value of RX detect register.

◆ getRxDetect_A() [1/2]

uint8_t getRxDetect_A ( )

Gets the RX detect of A channel This function reads the RX detect register and returns the channel A status.

Returns
4 bit value of channel A RX detect.

◆ getRxDetect_A() [2/2]

uint8_t getRxDetect_A ( uint8_t index)

Gets the RX detect A by channel index This function reads the RX detect register value and returns the status of given channel index of A channel.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
Returns
return zero for not detected, otherwise for detected.

◆ getRxDetect_B() [1/2]

uint8_t getRxDetect_B ( )

Gets the RX detect of B channel This function reads the RX detect register and returns the channel B status.

Returns
4 bit value of channel B RX detect.

◆ getRxDetect_B() [2/2]

uint8_t getRxDetect_B ( uint8_t index)

Gets the RX detect B by channel index This function reads the RX detect register value and returns the status of given channel index of B channel.

Parameters
indexA reference to the channel index of B channel from 0 to 3.
Returns
return zero for not detected, otherwise for detected.

◆ getPowerDown()

uint8_t getPowerDown ( )

Gets the power down register This function reads the power down register values.

Returns
8 bit value of power down register.

◆ getPowerDown_A() [1/2]

uint8_t getPowerDown_A ( )

Gets the power down of A channel This function reads the power down register and returns the channel A status.

Returns
4 bit value of channel A power down.

◆ getPowerDown_A() [2/2]

uint8_t getPowerDown_A ( uint8_t index)

Gets the power down A by channel index This function reads the power down register value and returns the status of given channel index of A channel.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
Returns
return zero for not detected, otherwise for detected.

◆ getPowerDown_B() [1/2]

uint8_t getPowerDown_B ( )

Gets the power down of B channel This function reads the power down register and returns the channel B status.

Returns
4 bit value of channel B power down.

◆ getPowerDown_B() [2/2]

uint8_t getPowerDown_B ( uint8_t index)

Gets the power down B by channel index This function reads the power down register value and returns the status of given channel index of B channel.

Parameters
indexA reference to the channel index of B channel from 0 to 3.
Returns
return zero for not detected, otherwise for detected.

◆ setPowerDown()

void setPowerDown ( uint8_t isDown)

Sets the power down register. This function change the power down status of all channels.

Parameters
isDown

◆ setPowerDown_A() [1/2]

void setPowerDown_A ( uint8_t isDown)

Sets the power down of A channel. This function change the power down status of channel A.

Parameters
isDown

◆ setPowerDown_A() [2/2]

void setPowerDown_A ( uint8_t index,
uint8_t isDown )

Sets the power down of a given index of A channel. This function change the power down status of the given channel A index.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
isDown

◆ setPowerDown_B() [1/2]

void setPowerDown_B ( uint8_t isDown)

Sets the power down of B channel. This function change the power down status of channel B.

Parameters
isDown

◆ setPowerDown_B() [2/2]

void setPowerDown_B ( uint8_t index,
uint8_t isDown )

Sets the power down of a given index of B channel. This function change the power down status of the given channel B index.

Parameters
indexA reference to the channel index of B channel from 0 to 3.
isDown

◆ getConfig_A0()

uint8_t getConfig_A0 ( )

Gets the configuration of the 0 index A channel. This function reads the configuration of the 0 index A channel value.

Returns
8 bit value of A0 config register.

◆ getEQ_A0()

uint8_t getEQ_A0 ( )

Gets the equalizer configuration of the 0 index A channel. This function reads the equalizer value of the 0 index A channel value.

Returns
4 bit value of A0 equalizer.

◆ getFlatGain_A0()

uint8_t getFlatGain_A0 ( )

Gets the flat gain configuration of the 0 index A channel. This function reads the flat gain value of the 0 index A channel value.

Returns
2 bit value of A0 flat gain:

◆ getSW_A0()

uint8_t getSW_A0 ( )

Gets the swing configuration of the 0 index A channel. This function reads the swing value of the 0 index A channel value.

Returns
1 bit value of A0 swing:

◆ setConfig_A0()

void setConfig_A0 ( uint8_t config)

Sets the configuration of the 0 index A channel. This function sets the configuration register of A0. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_A0()

void setEQ_A0 ( uint8_t EQ)

Sets the equalizer value of the 0 index A channel. This function sets the equalizer value of A0.

Parameters
EQ4 bit value of the equalizer index

◆ setFlatGain_A0()

void setFlatGain_A0 ( uint8_t flat_gain)

Sets the flat gain value of the 0 index A channel. This function sets the flat gain value of A0.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_A0()

void setSW_A0 ( uint8_t swing)

Sets the swing value of the 0 index A channel. This function sets the swing value of A0.

Parameters
swing1 bit value of the swing:

◆ getConfig_A1()

uint8_t getConfig_A1 ( )

Gets the configuration of the 1 index A channel. This function reads the configuration of the 1 index A channel value.

Returns
8 bit value of A1 config register.

◆ getEQ_A1()

uint8_t getEQ_A1 ( )

Gets the equalizer configuration of the 1 index A channel. This function reads the equalizer value of the 1 index A channel value.

Returns
4 bit value of A1 equalizer.

◆ getFlatGain_A1()

uint8_t getFlatGain_A1 ( )

Gets the flat gain configuration of the 1 index A channel. This function reads the flat gain value of the 1 index A channel value.

Returns
2 bit value of A1 flat gain:

◆ getSW_A1()

uint8_t getSW_A1 ( )

Gets the swing configuration of the 1 index A channel. This function reads the swing value of the 1 index A channel value.

Returns
1 bit value of A1 swing:

◆ setConfig_A1()

void setConfig_A1 ( uint8_t config)

Sets the configuration of the 1 index A channel. This function sets the configuration register of A1. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_A1()

void setEQ_A1 ( uint8_t EQ)

Sets the equalizer value of the 1 index A channel. This function sets the equalizer value of A1.

Parameters
EQ4 bit value of the equalizer index

◆ setFlatGain_A1()

void setFlatGain_A1 ( uint8_t flat_gain)

Sets the flat gain value of the 1 index A channel. This function sets the flat gain value of A1.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_A1()

void setSW_A1 ( uint8_t swing)

Sets the swing value of the 1 index A channel. This function sets the swing value of A1.

Parameters
swing1 bit value of the swing:

◆ getConfig_A2()

uint8_t getConfig_A2 ( )

Gets the configuration of the 2 index A channel. This function reads the configuration of the 2 index A channel value.

Returns
8 bit value of A2 config register.

◆ getEQ_A2()

uint8_t getEQ_A2 ( )

Gets the equalizer configuration of the 2 index A channel. This function reads the equalizer value of the 2 index A channel value.

Returns
4 bit value of A2 equalizer.

◆ getFlatGain_A2()

uint8_t getFlatGain_A2 ( )

Gets the flat gain configuration of the 2 index A channel. This function reads the flat gain value of the 2 index A channel value.

Returns
2 bit value of A2 flat gain:

◆ getSW_A2()

uint8_t getSW_A2 ( )

Gets the swing configuration of the 2 index A channel. This function reads the swing value of the 2 index A channel value.

Returns
1 bit value of A2 swing:

◆ setConfig_A2()

void setConfig_A2 ( uint8_t config)

Sets the configuration of the 2 index A channel. This function sets the configuration register of A2. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_A2()

void setEQ_A2 ( uint8_t EQ)

Sets the equalizer value of the 2 index A channel. This function sets the equalizer value of A2.

Parameters
EQ4 bit value of the equalizer index

◆ setFlatGain_A2()

void setFlatGain_A2 ( uint8_t flat_gain)

Sets the flat gain value of the 2 index A channel. This function sets the flat gain value of A2.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_A2()

void setSW_A2 ( uint8_t swing)

Sets the swing value of the 2 index A channel. This function sets the swing value of A2.

Parameters
swing1 bit value of the swing:

◆ getConfig_A3()

uint8_t getConfig_A3 ( )

Gets the configuration of the 3 index A channel. This function reads the configuration of the 3 index A channel value.

Returns
8 bit value of A3 config register.

◆ getEQ_A3()

uint8_t getEQ_A3 ( )

Gets the equalizer configuration of the 3 index A channel. This function reads the equalizer value of the 3 index A channel value.

Returns
4 bit value of A3 equalizer.

◆ getFlatGain_A3()

uint8_t getFlatGain_A3 ( )

Gets the flat gain configuration of the 3 index A channel. This function reads the flat gain value of the 3 index A channel value.

Returns
2 bit value of A3 flat gain:

◆ getSW_A3()

uint8_t getSW_A3 ( )

Gets the swing configuration of the 3 index A channel. This function reads the swing value of the 3 index A channel value.

Returns
1 bit value of A3 swing:

◆ setConfig_A3()

void setConfig_A3 ( uint8_t config)

Sets the configuration of the 3 index A channel. This function sets the configuration register of A3. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_A3()

void setEQ_A3 ( uint8_t EQ)

Sets the equalizer value of the 3 index A channel. This function sets the equalizer value of A3.

Parameters
EQ4 bit value of the equalizer index

◆ setFlatGain_A3()

void setFlatGain_A3 ( uint8_t flat_gain)

Sets the flat gain value of the 3 index A channel. This function sets the flat gain value of A3.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_A3()

void setSW_A3 ( uint8_t swing)

Sets the swing value of the 3 index A channel. This function sets the swing value of A3.

Parameters
swing1 bit value of the swing:

◆ getConfig_B0()

uint8_t getConfig_B0 ( )

Gets the configuration of the 0 index B channel. This function reads the configuration of the 0 index B channel value.

Returns
8 bit value of B0 config register.

◆ getEQ_B0()

uint8_t getEQ_B0 ( )

Gets the equalizer configuration of the 0 index B channel. This function reads the equalizer value of the 0 index B channel value.

Returns
4 bit value of B0 equalizer.

◆ getFlatGain_B0()

uint8_t getFlatGain_B0 ( )

Gets the flat gain configuration of the 0 index B channel. This function reads the flat gain value of the 0 index B channel value.

Returns
2 bit value of B0 flat gain:

◆ getSW_B0()

uint8_t getSW_B0 ( )

Gets the swing configuration of the 0 index B channel. This function reads the swing value of the 0 index B channel value.

Returns
1 bit value of B0 swing:

◆ setConfig_B0()

void setConfig_B0 ( uint8_t config)

Sets the configuration of the 0 index B channel. This function sets the configuration register of B0. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_B0()

void setEQ_B0 ( uint8_t EQ)

Sets the equalizer value of the 0 index B channel. This function sets the equalizer value of B0.

Parameters
EQ4 bit value of the equalizer index

◆ setFlatGain_B0()

void setFlatGain_B0 ( uint8_t flat_gain)

Sets the flat gain value of the 0 index B channel. This function sets the flat gain value of B0.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_B0()

void setSW_B0 ( uint8_t swing)

Sets the swing value of the 0 index B channel. This function sets the swing value of B0.

Parameters
swing1 bit value of the swing:

◆ getConfig_B1()

uint8_t getConfig_B1 ( )

Gets the configuration of the 1 index B channel. This function reads the configuration of the 1 index B channel value.

Returns
8 bit value of B1 config register.

◆ getEQ_B1()

uint8_t getEQ_B1 ( )

Gets the equalizer configuration of the 1 index B channel. This function reads the equalizer value of the 1 index B channel value.

Returns
4 bit value of B1 equalizer.

◆ getFlatGain_B1()

uint8_t getFlatGain_B1 ( )

Gets the flat gain configuration of the 1 index B channel. This function reads the flat gain value of the 1 index B channel value.

Returns
2 bit value of B1 flat gain:

◆ getSW_B1()

uint8_t getSW_B1 ( )

Gets the swing configuration of the 1 index B channel. This function reads the swing value of the 1 index B channel value.

Returns
1 bit value of B1 swing:

◆ setConfig_B1()

void setConfig_B1 ( uint8_t config)

Sets the configuration of the 1 index B channel. This function sets the configuration register of B1. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_B1()

void setEQ_B1 ( uint8_t EQ)

Sets the equalizer value of the 1 index B channel. This function sets the equalizer value of B1.

Parameters
EQ4 bit value of the equalizer index

◆ setFlatGain_B1()

void setFlatGain_B1 ( uint8_t flat_gain)

Sets the flat gain value of the 1 index B channel. This function sets the flat gain value of B1.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_B1()

void setSW_B1 ( uint8_t swing)

Sets the swing value of the 1 index B channel. This function sets the swing value of B1.

Parameters
swing1 bit value of the swing:

◆ getConfig_B2()

uint8_t getConfig_B2 ( )

Gets the configuration of the 2 index B channel. This function reads the configuration of the 2 index B channel value.

Returns
8 bit value of B2 config register.

◆ getEQ_B2()

uint8_t getEQ_B2 ( )

Gets the equalizer configuration of the 2 index B channel. This function reads the equalizer value of the 2 index B channel value.

Returns
4 bit value of B2 equalizer.

◆ getFlatGain_B2()

uint8_t getFlatGain_B2 ( )

Gets the flat gain configuration of the 2 index B channel. This function reads the flat gain value of the 2 index B channel value.

Returns
2 bit value of B2 flat gain:

◆ getSW_B2()

uint8_t getSW_B2 ( )

Gets the swing configuration of the 2 index B channel. This function reads the swing value of the 2 index B channel value.

Returns
1 bit value of B2 swing:

◆ setConfig_B2()

void setConfig_B2 ( uint8_t config)

Sets the configuration of the 2 index B channel. This function sets the configuration register of B2. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_B2()

void setEQ_B2 ( uint8_t EQ)

Sets the equalizer value of the 2 index B channel. This function sets the equalizer value of B2.

Parameters
EQ4 bit value of the equalizer index

◆ setFlatGain_B2()

void setFlatGain_B2 ( uint8_t flat_gain)

Sets the flat gain value of the 2 index B channel. This function sets the flat gain value of B2.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_B2()

void setSW_B2 ( uint8_t swing)

Sets the swing value of the 2 index B channel. This function sets the swing value of B2.

Parameters
swing1 bit value of the swing:

◆ getConfig_B3()

uint8_t getConfig_B3 ( )

Gets the configuration of the 3 index B channel. This function reads the configuration of the 3 index B channel value.

Returns
8 bit value of B3 config register.

◆ getEQ_B3()

uint8_t getEQ_B3 ( )

Gets the equalizer configuration of the 3 index B channel. This function reads the equalizer value of the 3 index B channel value.

Returns
4 bit value of B3 equalizer.

◆ getFlatGain_B3()

uint8_t getFlatGain_B3 ( )

Gets the flat gain configuration of the 3 index B channel. This function reads the flat gain value of the 3 index B channel value.

Returns
2 bit value of B3 flat gain:

◆ getSW_B3()

uint8_t getSW_B3 ( )

Gets the swing configuration of the 3 index B channel. This function reads the swing value of the 3 index B channel value.

Returns
1 bit value of B3 swing:

◆ setConfig_B3()

void setConfig_B3 ( uint8_t config)

Sets the configuration of the 3 index B channel. This function sets the configuration register of B3. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_B3()

void setEQ_B3 ( uint8_t EQ)

Sets the equalizer value of the 3 index B channel. This function sets the equalizer value of B3.

Parameters
EQ4 bit value of the equalizer index

◆ setFlatGain_B3()

void setFlatGain_B3 ( uint8_t flat_gain)

Sets the flat gain value of the 3 index B channel. This function sets the flat gain value of B3.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_B3()

void setSW_B3 ( uint8_t swing)

Sets the swing value of the 3 index B channel. This function sets the swing value of B3.

Parameters
swing1 bit value of the swing:

◆ getSignalDetectConfig()

uint8_t getSignalDetectConfig ( )

Gets the signal detect configuration register This function reads the signal detect configuration register values.

Returns
8 bit value of signal detect configuration register.

◆ getSignalDetectConfig_A() [1/2]

uint8_t getSignalDetectConfig_A ( )

Gets the signal detect configuration of A channel This function reads the signal detect configuration register and returns the channel A status.

Returns
4 bit value of channel A signal detect configuration.

◆ getSignalDetectConfig_A() [2/2]

uint8_t getSignalDetectConfig_A ( uint8_t index)

Gets the signal detect configuration A by channel index This function reads the signal detect configuration register value.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
Returns
return zero for enabled, otherwise for disabled.

◆ getSignalDetectConfig_B() [1/2]

uint8_t getSignalDetectConfig_B ( )

Gets the signal detect configuration of B channel This function reads the signal detect configuration register and returns the channel B status.

Returns
4 bit value of channel B signal detect configuration.

◆ getSignalDetectConfig_B() [2/2]

uint8_t getSignalDetectConfig_B ( uint8_t index)

Gets the signal detect configuration B by channel index This function reads the signal detect configuration register value.

Parameters
indexA reference to the channel index of B channel from 0 to 3.
Returns
return zero for enabled, otherwise for disabled.

◆ setSignalDetectConfig()

void setSignalDetectConfig ( uint8_t isDown)

Sets the signal detect configuration register. This function change the signal detect configuration of all channels.

Parameters
isDown

◆ setSignalDetectConfig_A() [1/2]

void setSignalDetectConfig_A ( uint8_t isDown)

Sets the signal detect configuration of A channel. This function change the signal detect configuration of channel A.

Parameters
isDown

◆ setSignalDetectConfig_A() [2/2]

void setSignalDetectConfig_A ( uint8_t index,
uint8_t isDown )

Sets the signal detect configuration of a given index of A channel. This function change the signal detect configuration of the given channel A index.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
isDown

◆ setSignalDetectConfig_B() [1/2]

void setSignalDetectConfig_B ( uint8_t isDown)

Sets the signal detect configuration of B channel. This function change the signal detect configuration of channel B.

Parameters
isDown

◆ setSignalDetectConfig_B() [2/2]

void setSignalDetectConfig_B ( uint8_t index,
uint8_t isDown )

Sets the signal detect configuration of a given index of B channel. This function change the signal detect configuration of the given channel B index.

Parameters
indexA reference to the channel index of B channel from 0 to 3.
isDown

◆ getRxDetectConfig()

uint8_t getRxDetectConfig ( )

Gets the RX detect configuration register This function reads the RX detect configuration register values.

Returns
8 bit value of RX detect configuration register.

◆ getRxDetectConfig_A() [1/2]

uint8_t getRxDetectConfig_A ( )

Gets the RX detect configuration of A channel This function reads the RX detect configuration register and returns the channel A status.

Returns
4 bit value of channel A RX detect configuration.

◆ getRxDetectConfig_A() [2/2]

uint8_t getRxDetectConfig_A ( uint8_t index)

Gets the RX detect configuration A by channel index This function reads the RX detect configuration register value.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
Returns
return zero for enabled, otherwise for disabled.

◆ getRxDetectConfig_B() [1/2]

uint8_t getRxDetectConfig_B ( )

Gets the RX detect configuration of B channel This function reads the RX detect configuration register and returns the channel B status.

Returns
4 bit value of channel B RX detect configuration.

◆ getRxDetectConfig_B() [2/2]

uint8_t getRxDetectConfig_B ( uint8_t index)

Gets the RX detect configuration B by channel index This function reads the RX detect configuration register value.

Parameters
indexA reference to the channel index of B channel from 0 to 3.
Returns
return zero for enabled, otherwise for disabled.

◆ setRxDetectConfig()

void setRxDetectConfig ( uint8_t isDown)

Sets the RX detect configuration register. This function change the RX detect configuration of all channels.

Parameters
isDown

◆ setRxDetectConfig_A() [1/2]

void setRxDetectConfig_A ( uint8_t isDown)

Sets the RX detect configuration of A channel. This function change the RX detect configuration of channel A.

Parameters
isDown

◆ setRxDetectConfig_A() [2/2]

void setRxDetectConfig_A ( uint8_t index,
uint8_t isDown )

Sets the RX detect configuration of a given index of A channel. This function change the RX detect configuration of the given channel A index.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
isDown

◆ setRxDetectConfig_B() [1/2]

void setRxDetectConfig_B ( uint8_t isDown)

Sets the RX detect configuration of B channel. This function change the RX detect configuration of channel B.

Parameters
isDown

◆ setRxDetectConfig_B() [2/2]

void setRxDetectConfig_B ( uint8_t index,
uint8_t isDown )

Sets the RX detect configuration of a given index of B channel. This function change the RX detect configuration of the given channel B index.

Parameters
indexA reference to the channel index of A channel from 0 to 3.
isDown

◆ getSDTConfig()

uint8_t getSDTConfig ( )

Gets the signal detect threshold of all channels. This function gets the signal detect threshold of all channels.

Returns
2 bit value of the signal detect threshold:

◆ setSDTConfig()

uint8_t setSDTConfig ( uint8_t thresh)

Sets the signal detect threshold for all channels. This function changes the signal detect threshold of all channels.

Parameters
thresh2 bit value of the threshold:

◆ setConfig_A() [1/2]

void setConfig_A ( uint8_t config)

Sets the configuration of the channel A This function sets the configuration of channel A. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setConfig_A() [2/2]

void setConfig_A ( uint8_t index,
uint8_t config )

Sets the configuration of the given index of channel A This function sets the configuration of the given index of channel A. This function is equal to setConfig_Ax(...) (x is channel index) NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setConfig_B() [1/2]

void setConfig_B ( uint8_t config)

Sets the configuration of the channel A This function sets the configuration of channel A. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setConfig_B() [2/2]

void setConfig_B ( uint8_t index,
uint8_t config )

Sets the configuration of the given index of channel B This function sets the configuration of the given index of channel B. This function is equal to setConfig_Bx(...) (x is channel index) NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setConfig()

void setConfig ( uint8_t config)

Sets the configuration of all channels This function sets the configuration of all channels. NOT RECOMENDED TO USE! **.

Parameters
config8 bit value of the config register

◆ setEQ_A()

void setEQ_A ( uint8_t EQ)

Sets the equalizer of the channel A This function sets the equalizer settings of the channel A.

Parameters
EQ4 bit value of the equalizer index

◆ setEQ_B()

void setEQ_B ( uint8_t EQ)

Sets the equalizer of the channel B This function sets the equalizer settings of the channel B.

Parameters
EQ4 bit value of the equalizer index

◆ setEQ()

void setEQ ( uint8_t EQ)

Sets the equalizer of the all channels This function sets the equalizer settings of the all channels.

Parameters
EQ4 bit value of the equalizer index

◆ setFG_A()

void setFG_A ( uint8_t flat_gain)

Sets the flat gain of the channel A This function sets the flat gain setting of the channel A.

Parameters
flat_gain2 bit value of the flat gain:

◆ setFG_B()

void setFG_B ( uint8_t flat_gain)

Sets the flat gain of the channel B This function sets the flat gain setting of the channel B.

Parameters
flat_gain2 bit value of the flat gain:

◆ setFG()

void setFG ( uint8_t flat_gain)

Sets the flat gain of all channels This function sets the flat gain setting of all channels.

Parameters
flat_gain2 bit value of the flat gain:

◆ setSW_A()

void setSW_A ( uint8_t swing)

Sets the swing value of the channel A This function sets the swing value of the channel A.

Parameters
swing1 bit value of the flat gain:

◆ setSW_B()

void setSW_B ( uint8_t swing)

Sets the swing value of the channel B This function sets the swing value of the channel B.

Parameters
swing1 bit value of the flat gain:

◆ setSW()

void setSW ( uint8_t swing)

Sets the swing value of all channels This function sets the swing value of all channels.

Parameters
swing1 bit value of the flat gain:

◆ dump_all()

void dump_all ( uint8_t * data)

Reads all of the registers This function reads all of the registers of the chip.

Parameters
dataA pointer to an array of 16 bytes to store the values.

The documentation for this class was generated from the following files: