usbcsink3 2.1.0.0
Macros
USB-C Sink 3 Registers Settings
USB-C Sink 3 Click Driver

Settings for registers of USB-C Sink 3 Click driver. More...

Macros

#define USBCSINK3_NO_PIN_BIT_MASK   0x00
 USB-C Sink 3 expander pin bit mask values.
 
#define USBCSINK3_PIN_0_BIT_MASK   0x01
 
#define USBCSINK3_PIN_1_BIT_MASK   0x02
 
#define USBCSINK3_PIN_2_BIT_MASK   0x04
 
#define USBCSINK3_PIN_3_BIT_MASK   0x08
 
#define USBCSINK3_ALL_PINS_BIT_MASK   0xF0
 
#define USBCSINK3_DIRECTION_OUTPUT   0x00
 USB-C Sink 3 expander I/O pin direction values.
 
#define USBCSINK3_DIRECTION_INPUT   0x01
 
#define USBCSINK3_VSEL0_DISABLE   0x00
 RS Transceiver expander VSEL pin direction values.
 
#define USBCSINK3_VSEL0_ENABLE   0x01
 
#define USBCSINK3_VSEL0_PIN_BIT_MASK   0x0E
 
#define USBCSINK3_VSEL1_DISABLE   0x00
 
#define USBCSINK3_VSEL1_ENABLE   0x02
 
#define USBCSINK3_VSEL1_PIN_BIT_MASK   0x0D
 
#define USBCSINK3_VSEL2_DISABLE   0x00
 
#define USBCSINK3_VSEL2_ENABLE   0x04
 
#define USBCSINK3_VSEL2_PIN_BIT_MASK   0x0B
 
#define USBCSINK3_SPEC_FUNC_P3_AS_INT   0x80
 USB-C Sink 3 expander special function values.
 
#define USBCSINK3_SPEC_FUNC_PU_DISABLED   0x40
 
#define USBCSINK3_VBUS_VTG_0V   0.0f
 USB-C Sink 3 VBUS voltage values.
 
#define USBCSINK3_VBUS_VTG_5V   5.0f
 
#define USBCSINK3_VBUS_VTG_9V   9.0f
 
#define USBCSINK3_VBUS_VTG_15V   15.0f
 
#define USBCSINK3_VBUS_VTG_20V   20.3f
 
#define USBCSINK3_VBUS_VTG_4_3V   4.3f
 
#define USBCSINK3_VBUS_VTG_8_6V   8.6f
 
#define USBCSINK3_VBUS_VTG_12_9V   12.9f
 
#define USBCSINK3_VBUS_VTG_17_2V   17.2f
 
#define USBCSINK3_WIPER_POS_MAX   255
 USB-C Sink 3 wiper and resistance data values.
 
#define USBCSINK3_RES_6_8_KOHM   6.8f
 
#define USBCSINK3_RES_16_KOHM   16.0f
 
#define USBCSINK3_RES_27_KOHM   27.0f
 
#define USBCSINK3_RES_36_KOHM   36.0f
 
#define USBCSINK3_RES_45_3_KOHM   45.3f
 
#define USBCSINK3_RES_56_KOHM   56.0f
 
#define USBCSINK3_RES_64_9_KOHM   64.9f
 
#define USBCSINK3_RES_75_KOHM   75.0f
 
#define USBCSINK3_RES_82_KOHM   82.0f
 
#define USBCSINK3_RES_91_KOHM   91.0f
 
#define USBCSINK3_RES_100_KOHM   100.0f
 
#define USBCSINK3_VBUS_R11_RES_73_2_KOHM   73.2f
 
#define USBCSINK3_VBUS_R13_RES_10_KOHM   10.0f
 
#define USBCSINK3_ADC_RESOLUTION   0x0FFF
 USB-C Sink 3 ADC setting.
 
#define USBCSINK3_VREF_3V3   3.3
 
#define USBCSINK3_VREF_5V   5.0
 
#define USBCSINK3_DEVICE_ADDRESS   0x41
 USB-C Sink 3 device address setting.
 
#define USBCSINK3_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define USBCSINK3_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 

Detailed Description

Settings for registers of USB-C Sink 3 Click driver.

Macro Definition Documentation

◆ USBCSINK3_ADC_RESOLUTION

#define USBCSINK3_ADC_RESOLUTION   0x0FFF

USB-C Sink 3 ADC setting.

Specified settings for ADC of USB-C Sink 3 Click driver.

◆ USBCSINK3_ALL_PINS_BIT_MASK

#define USBCSINK3_ALL_PINS_BIT_MASK   0xF0

◆ USBCSINK3_DEVICE_ADDRESS

#define USBCSINK3_DEVICE_ADDRESS   0x41

USB-C Sink 3 device address setting.

Specified setting for device slave address selection of USB-C Sink 3 Click driver.

◆ USBCSINK3_DIRECTION_INPUT

#define USBCSINK3_DIRECTION_INPUT   0x01

◆ USBCSINK3_DIRECTION_OUTPUT

#define USBCSINK3_DIRECTION_OUTPUT   0x00

USB-C Sink 3 expander I/O pin direction values.

Specified I/O pin direction values of USB-C Sink 3 Click driver.

◆ USBCSINK3_NO_PIN_BIT_MASK

#define USBCSINK3_NO_PIN_BIT_MASK   0x00

USB-C Sink 3 expander pin bit mask values.

Specified expander pin bit mask values of USB-C Sink 3 Click driver.

◆ USBCSINK3_PIN_0_BIT_MASK

#define USBCSINK3_PIN_0_BIT_MASK   0x01

◆ USBCSINK3_PIN_1_BIT_MASK

#define USBCSINK3_PIN_1_BIT_MASK   0x02

◆ USBCSINK3_PIN_2_BIT_MASK

#define USBCSINK3_PIN_2_BIT_MASK   0x04

◆ USBCSINK3_PIN_3_BIT_MASK

#define USBCSINK3_PIN_3_BIT_MASK   0x08

◆ USBCSINK3_RES_100_KOHM

#define USBCSINK3_RES_100_KOHM   100.0f

◆ USBCSINK3_RES_16_KOHM

#define USBCSINK3_RES_16_KOHM   16.0f

◆ USBCSINK3_RES_27_KOHM

#define USBCSINK3_RES_27_KOHM   27.0f

◆ USBCSINK3_RES_36_KOHM

#define USBCSINK3_RES_36_KOHM   36.0f

◆ USBCSINK3_RES_45_3_KOHM

#define USBCSINK3_RES_45_3_KOHM   45.3f

◆ USBCSINK3_RES_56_KOHM

#define USBCSINK3_RES_56_KOHM   56.0f

◆ USBCSINK3_RES_64_9_KOHM

#define USBCSINK3_RES_64_9_KOHM   64.9f

◆ USBCSINK3_RES_6_8_KOHM

#define USBCSINK3_RES_6_8_KOHM   6.8f

◆ USBCSINK3_RES_75_KOHM

#define USBCSINK3_RES_75_KOHM   75.0f

◆ USBCSINK3_RES_82_KOHM

#define USBCSINK3_RES_82_KOHM   82.0f

◆ USBCSINK3_RES_91_KOHM

#define USBCSINK3_RES_91_KOHM   91.0f

◆ USBCSINK3_SET_DATA_SAMPLE_EDGE

#define USBCSINK3_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE

Data sample selection.

This macro sets data samples for SPI modules.

Note
Available only on Microchip PIC family devices. This macro will set data sampling for all SPI modules on MCU. Can be overwritten with usbcsink3_init which will set SET_SPI_DATA_SAMPLE_MIDDLE by default on the mapped mikrobus.

◆ USBCSINK3_SET_DATA_SAMPLE_MIDDLE

#define USBCSINK3_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE

◆ USBCSINK3_SPEC_FUNC_P3_AS_INT

#define USBCSINK3_SPEC_FUNC_P3_AS_INT   0x80

USB-C Sink 3 expander special function values.

Specified special function values of USB-C Sink 3 Click driver.

◆ USBCSINK3_SPEC_FUNC_PU_DISABLED

#define USBCSINK3_SPEC_FUNC_PU_DISABLED   0x40

◆ USBCSINK3_VBUS_R11_RES_73_2_KOHM

#define USBCSINK3_VBUS_R11_RES_73_2_KOHM   73.2f

◆ USBCSINK3_VBUS_R13_RES_10_KOHM

#define USBCSINK3_VBUS_R13_RES_10_KOHM   10.0f

◆ USBCSINK3_VBUS_VTG_0V

#define USBCSINK3_VBUS_VTG_0V   0.0f

USB-C Sink 3 VBUS voltage values.

Specified VBUS voltage of USB-C Sink 3 Click driver.

◆ USBCSINK3_VBUS_VTG_12_9V

#define USBCSINK3_VBUS_VTG_12_9V   12.9f

◆ USBCSINK3_VBUS_VTG_15V

#define USBCSINK3_VBUS_VTG_15V   15.0f

◆ USBCSINK3_VBUS_VTG_17_2V

#define USBCSINK3_VBUS_VTG_17_2V   17.2f

◆ USBCSINK3_VBUS_VTG_20V

#define USBCSINK3_VBUS_VTG_20V   20.3f

◆ USBCSINK3_VBUS_VTG_4_3V

#define USBCSINK3_VBUS_VTG_4_3V   4.3f

◆ USBCSINK3_VBUS_VTG_5V

#define USBCSINK3_VBUS_VTG_5V   5.0f

◆ USBCSINK3_VBUS_VTG_8_6V

#define USBCSINK3_VBUS_VTG_8_6V   8.6f

◆ USBCSINK3_VBUS_VTG_9V

#define USBCSINK3_VBUS_VTG_9V   9.0f

◆ USBCSINK3_VREF_3V3

#define USBCSINK3_VREF_3V3   3.3

◆ USBCSINK3_VREF_5V

#define USBCSINK3_VREF_5V   5.0

◆ USBCSINK3_VSEL0_DISABLE

#define USBCSINK3_VSEL0_DISABLE   0x00

RS Transceiver expander VSEL pin direction values.

Specified VSEL pin direction values of RS Transceiver Click driver.

◆ USBCSINK3_VSEL0_ENABLE

#define USBCSINK3_VSEL0_ENABLE   0x01

◆ USBCSINK3_VSEL0_PIN_BIT_MASK

#define USBCSINK3_VSEL0_PIN_BIT_MASK   0x0E

◆ USBCSINK3_VSEL1_DISABLE

#define USBCSINK3_VSEL1_DISABLE   0x00

◆ USBCSINK3_VSEL1_ENABLE

#define USBCSINK3_VSEL1_ENABLE   0x02

◆ USBCSINK3_VSEL1_PIN_BIT_MASK

#define USBCSINK3_VSEL1_PIN_BIT_MASK   0x0D

◆ USBCSINK3_VSEL2_DISABLE

#define USBCSINK3_VSEL2_DISABLE   0x00

◆ USBCSINK3_VSEL2_ENABLE

#define USBCSINK3_VSEL2_ENABLE   0x04

◆ USBCSINK3_VSEL2_PIN_BIT_MASK

#define USBCSINK3_VSEL2_PIN_BIT_MASK   0x0B

◆ USBCSINK3_WIPER_POS_MAX

#define USBCSINK3_WIPER_POS_MAX   255

USB-C Sink 3 wiper and resistance data values.

Specified wiper and resistance data values of USB-C Sink 3 Click driver.