usbcsource  2.0.0.0
usbcsource.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef USBCSOURCE_H
29 #define USBCSOURCE_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define USBCSOURCE_REG_ALERT_STATUS_REG 0x0B
60 #define USBCSOURCE_REG_ALERT_STATUS_MASK_CTRL 0x0C
61 #define USBCSOURCE_REG_CC_CONNECTION_STATUS_TRANS 0x0D
62 #define USBCSOURCE_REG_CC_CONNECTION_STATUS_1 0x0E
63 #define USBCSOURCE_REG_MONITORING_STATUS_TRANS 0x0F
64 #define USBCSOURCE_REG_MONITORING_STATUS 0x10
65 #define USBCSOURCE_REG_CC_CONNECTION_STATUS_2 0x11
66 #define USBCSOURCE_REG_HW_FAULT_STATUS_TRANS 0x12
67 #define USBCSOURCE_REG_HW_FAULT_STATUS 0x13
68 #define USBCSOURCE_REG_CC_CAPABILITY_CTRL 0x18
69 #define USBCSOURCE_REG_RESET_CTRL 0x23
70 #define USBCSOURCE_REG_VBUS_DISCHARGE_TIME_CTRL 0x25
71 #define USBCSOURCE_REG_VBUS_DISCHARGE_STATUS 0x26
72 #define USBCSOURCE_REG_VBUS_ENABLE_STATUS 0x27
73 #define USBCSOURCE_REG_VBUS_MONITORING_CTRL 0x2E
74 
75 #define USBCSOURCE_REG_SRC_PDO1 0x71
76 #define USBCSOURCE_REG_SRC_PDO2 0x75
77 #define USBCSOURCE_REG_SRC_PDO3 0x79
78 #define USBCSOURCE_REG_SRC_PDO4 0x7D
79 #define USBCSOURCE_REG_SRC_PDO5 0x81
80  // usbcsource_reg
82 
102 #define USBCSOURCE_SEL_PDO1 0x01
103 #define USBCSOURCE_SEL_PDO2 0x02
104 #define USBCSOURCE_SEL_PDO3 0x03
105 #define USBCSOURCE_SEL_PDO4 0x04
106 #define USBCSOURCE_SEL_PDO5 0x05
107 
112 #define USBCSOURCE_PDO_NVM_VOLT_CFG_9_V 0x00
113 #define USBCSOURCE_PDO_NVM_VOLT_CFG_15_V 0x01
114 #define USBCSOURCE_PDO_NVM_VOLT_CFG_FLEX_V1 0x02
115 #define USBCSOURCE_PDO_NVM_VOLT_CFG_FLEX_V2 0x03
116 
121 #define USBCSOURCE_PDO_NVM_CUR_FLEX_I 0x00
122 #define USBCSOURCE_PDO_NVM_CUR_1_50_A 0x01
123 #define USBCSOURCE_PDO_NVM_CUR_1_75_A 0x02
124 #define USBCSOURCE_PDO_NVM_CUR_2_00_A 0x03
125 #define USBCSOURCE_PDO_NVM_CUR_2_25_A 0x04
126 #define USBCSOURCE_PDO_NVM_CUR_2_50_A 0x05
127 #define USBCSOURCE_PDO_NVM_CUR_2_75_A 0x06
128 #define USBCSOURCE_PDO_NVM_CUR_3_00_A 0x07
129 #define USBCSOURCE_PDO_NVM_CUR_3_25_A 0x08
130 #define USBCSOURCE_PDO_NVM_CUR_3_50_A 0x09
131 #define USBCSOURCE_PDO_NVM_CUR_3_75_A 0x0A
132 #define USBCSOURCE_PDO_NVM_CUR_4_00_A 0x0B
133 #define USBCSOURCE_PDO_NVM_CUR_4_25_A 0x0C
134 #define USBCSOURCE_PDO_NVM_CUR_4_50_A 0x0D
135 #define USBCSOURCE_PDO_NVM_CUR_4_75_A 0x0E
136 #define USBCSOURCE_PDO_NVM_CUR_5_00_A 0x0F
137 
142 #define USBCSOURCE_RESET_DIS 0x00
143 #define USBCSOURCE_RESET_EN 0x01
144 
149 #define USBCSOURCE_ALERT_STAT_HARD_RESET_AL 0x80
150 #define USBCSOURCE_ALERT_STAT_PORT_STAT_AL 0x40
151 #define USBCSOURCE_ALERT_STAT_TYPEC_MON_AL 0x20
152 #define USBCSOURCE_ALERT_STAT_CC_HW_FAULT_AL 0x10
153 #define USBCSOURCE_ALERT_STAT_DPM_STAT_AL 0x08
154 #define USBCSOURCE_ALERT_STAT_PE_STAT_AL 0x04
155 #define USBCSOURCE_ALERT_STAT_PRT_STAT_AL 0x02
156 #define USBCSOURCE_ALERT_STAT_PHY_STAT_AL 0x01
157 
162 #define USBCSOURCE_ATTACHED_DEVICE_NONE_ATT 0x00
163 #define USBCSOURCE_ATTACHED_DEVICE_SNK_ATT 0x01
164 #define USBCSOURCE_ATTACHED_DEVICE_SRC_ATT 0x02
165 #define USBCSOURCE_ATTACHED_DEVICE_DBG_ATT 0x03
166 #define USBCSOURCE_ATTACHED_DEVICE_AUD_ATT 0x04
167 #define USBCSOURCE_ATTACHED_DEVICE_POW_ACC_ATT 0x05
168 
173 #define USBCSOURCE_LOW_POWER_STANDBY_OFF 0x00
174 #define USBCSOURCE_LOW_POWER_STANDBY_ON 0x01
175 
180 #define USBCSOURCE_POWER_MODE_SNK 0x00
181 #define USBCSOURCE_POWER_MODE_SRC 0x01
182 
187 #define USBCSOURCE_DATA_MODE_UFP 0x00
188 #define USBCSOURCE_DATA_MODE_DFP 0x01
189 
194 #define USBCSOURCE_CONN_UNATTACHED 0x00
195 #define USBCSOURCE_CONN_ATTACHED 0x01
196 
201 #define USBCSOURCE_VBUS_READY_DISCONNECTED 0x00
202 #define USBCSOURCE_VBUS_READY_CONNECTED 0x01
203 
204 #define USBCSOURCE_VBUS_VSAFE0V_0_8V_HIGHER 0x00
205 #define USBCSOURCE_VBUS_VSAFE0V_0_8V_LOWER 0x01
206 
207 #define USBCSOURCE_VBUS_VALID_3_9V_LOWER 0x00
208 #define USBCSOURCE_VBUS_VALID_3_9V_HIGHER 0x01
209 
214 #define USBCSOURCE_STATUS_ERROR 0x00
215 #define USBCSOURCE_STATUS_SUCCESS 0x01
216 
222 #define USBCSOURCE_I2C_SLAVE_ADR_GND 0x28
223 #define USBCSOURCE_I2C_SLAVE_ADR_VCC 0x29
224  // usbcsource_set
226 
241 #define USBCSOURCE_MAP_MIKROBUS( cfg, mikrobus ) \
242  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
243  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
244  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
245  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
246  // usbcsource_map // usbcsource
249 
254 typedef struct
255 {
256  // Output pins
257  digital_out_t rst;
259  // Input pins
260  digital_in_t int_pin;
262  // Modules
263  i2c_master_t i2c;
265  // I2C slave address
266  uint8_t slave_address;
268 } usbcsource_t;
269 
274 typedef struct
275 {
276  pin_name_t scl;
277  pin_name_t sda;
279  pin_name_t rst;
280  pin_name_t int_pin;
282  uint32_t i2c_speed;
283  uint8_t i2c_address;
286 
291 typedef struct
292 {
293  uint8_t hard_reset_al;
294  uint8_t port_status_al;
297  uint8_t prt_status_al;
298  uint8_t phy_status_al;
300 
305 typedef struct
306 {
309  uint8_t power_mode;
310  uint8_t data_mode;
311  uint8_t vconn_mode;
312  uint8_t attach;
313 } port_status_t;
314 
319 typedef struct
320 {
322  uint8_t vbus_ready;
323  uint8_t vbus_vsafe0v;
324  uint8_t vbus_valid;
325  uint8_t vconn_valid;
327 
332 typedef struct
333 {
334  uint8_t cc_reverse;
338 
343 typedef struct
344 {
345  uint8_t th_145_status;
351  uint8_t vpu_ovp_fault;
352  uint8_t vpu_valid;
360 
365 typedef struct
366 {
367  uint8_t pdo_number;
368  uint8_t fixed_supply;
371  uint8_t unconstr_power;
373  uint8_t dual_role_data;
375  uint8_t peak_current;
376  float vtg_data;
377  float curr_data;
378 } pdo_config_t;
379 
384 typedef enum
385 {
387  USBCSOURCE_ERROR = -1
388 
390 
407 
422 
437 err_t usbcsource_generic_write ( usbcsource_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
438 
453 err_t usbcsource_generic_read ( usbcsource_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
454 
467 void usbcsource_write_byte ( usbcsource_t *ctx, uint8_t reg, uint8_t tx_data );
468 
480 uint8_t usbcsource_read_byte ( usbcsource_t *ctx, uint8_t reg );
481 
493 
505 
518 void usbcsource_get_alert_status ( usbcsource_t *ctx, alert_status_t *alert_status_data );
519 
532 void usbcsource_set_alert_status ( usbcsource_t *ctx, alert_status_t alert_status_data );
533 
546 
559 void usbcsource_get_port_status ( usbcsource_t *ctx, port_status_t *port_status_data );
560 
575 
589 
604 
616 
628 uint8_t usbcsource_set_pdo_config ( usbcsource_t *ctx, pdo_config_t pdo_cfg_data );
629 
642 uint8_t usbcsource_get_pdo_config ( usbcsource_t *ctx, uint8_t pdo_numb, pdo_config_t *pdo_cfg_data );
643 
662 
663 #ifdef __cplusplus
664 }
665 #endif
666 #endif // USBCSOURCE_H
667  // usbcsource
669 
670 // ------------------------------------------------------------------------ END
fault_status_t::vconn_sw_ocp_fault_cc1
uint8_t vconn_sw_ocp_fault_cc1
Definition: usbcsource.h:355
usbcsource_default_config
void usbcsource_default_config(usbcsource_t *ctx)
Default configuration function.
monitor_status_t::vconn_valid
uint8_t vconn_valid
Definition: usbcsource.h:325
usbcsource_get_port_status
void usbcsource_get_port_status(usbcsource_t *ctx, port_status_t *port_status_data)
Get port status function.
usbcsource_t
USB-C Source Click context object.
Definition: usbcsource.h:255
port_status_t::attached_device
uint8_t attached_device
Definition: usbcsource.h:307
usbcsource_t::int_pin
digital_in_t int_pin
Definition: usbcsource.h:260
monitor_status_t::vbus_vsafe0v
uint8_t vbus_vsafe0v
Definition: usbcsource.h:323
fault_status_t::vconn_sw_ovp_fault_trans
uint8_t vconn_sw_ovp_fault_trans
Definition: usbcsource.h:350
pdo_config_t::unch_exd_mesg_support
uint8_t unch_exd_mesg_support
Definition: usbcsource.h:374
connection_status_t::snk_power_level
uint8_t snk_power_level
Definition: usbcsource.h:335
alert_status_t::port_status_al
uint8_t port_status_al
Definition: usbcsource.h:294
monitor_status_t::pd_typec_hand_check
uint8_t pd_typec_hand_check
Definition: usbcsource.h:321
connection_status_t::typec_fsm_state
uint8_t typec_fsm_state
Definition: usbcsource.h:336
fault_status_t::vconn_sw_ovp_fault_cc1
uint8_t vconn_sw_ovp_fault_cc1
Definition: usbcsource.h:357
alert_status_t::phy_status_al
uint8_t phy_status_al
Definition: usbcsource.h:298
pdo_config_t::vtg_data
float vtg_data
Definition: usbcsource.h:376
fault_status_t
USB-C Source Click fault status object.
Definition: usbcsource.h:344
fault_status_t::vconn_sw_ovp_fault_cc2
uint8_t vconn_sw_ovp_fault_cc2
Definition: usbcsource.h:358
port_status_t::low_power_standby
uint8_t low_power_standby
Definition: usbcsource.h:308
usbcsource_hw_reset
void usbcsource_hw_reset(usbcsource_t *ctx)
HW reset function.
pdo_config_t::peak_current
uint8_t peak_current
Definition: usbcsource.h:375
fault_status_t::vconn_sw_rvp_fault_cc1
uint8_t vconn_sw_rvp_fault_cc1
Definition: usbcsource.h:353
usbcsource_init
err_t usbcsource_init(usbcsource_t *ctx, usbcsource_cfg_t *cfg)
USB-C Source initialization function.
usbcsource_cfg_t::int_pin
pin_name_t int_pin
Definition: usbcsource.h:280
port_status_t::power_mode
uint8_t power_mode
Definition: usbcsource.h:309
usbcsource_write_byte
void usbcsource_write_byte(usbcsource_t *ctx, uint8_t reg, uint8_t tx_data)
Generic write function.
monitor_status_t::vbus_valid
uint8_t vbus_valid
Definition: usbcsource.h:324
pdo_config_t::usb_commun_capable
uint8_t usb_commun_capable
Definition: usbcsource.h:372
fault_status_t::vpu_valid_trans
uint8_t vpu_valid_trans
Definition: usbcsource.h:347
pdo_config_t::pdo_number
uint8_t pdo_number
Definition: usbcsource.h:367
alert_status_t::typec_monitoring_status_al
uint8_t typec_monitoring_status_al
Definition: usbcsource.h:295
fault_status_t::vconn_sw_ocp_fault_trans
uint8_t vconn_sw_ocp_fault_trans
Definition: usbcsource.h:349
fault_status_t::vpu_valid
uint8_t vpu_valid
Definition: usbcsource.h:352
port_status_t::attach
uint8_t attach
Definition: usbcsource.h:312
monitor_status_t
USB-C Source Click monitor status object.
Definition: usbcsource.h:320
alert_status_t
USB-C Source Click alert status object.
Definition: usbcsource.h:292
usbcsource_cfg_t::rst
pin_name_t rst
Definition: usbcsource.h:279
usbcsource_sw_reset
void usbcsource_sw_reset(usbcsource_t *ctx)
SW reset function.
monitor_status_t::vbus_ready
uint8_t vbus_ready
Definition: usbcsource.h:322
port_status_t::data_mode
uint8_t data_mode
Definition: usbcsource.h:310
pdo_config_t::curr_data
float curr_data
Definition: usbcsource.h:377
port_status_t
USB-C Source Click port status object.
Definition: usbcsource.h:306
usbcsource_check_attach_trans
uint8_t usbcsource_check_attach_trans(usbcsource_t *ctx)
Check attach trans function.
alert_status_t::prt_status_al
uint8_t prt_status_al
Definition: usbcsource.h:297
USBCSOURCE_ERROR
@ USBCSOURCE_ERROR
Definition: usbcsource.h:387
alert_status_t::cc_hw_fault_status_al
uint8_t cc_hw_fault_status_al
Definition: usbcsource.h:296
usbcsource_cfg_t::i2c_address
uint8_t i2c_address
Definition: usbcsource.h:283
usbcsource_t::i2c
i2c_master_t i2c
Definition: usbcsource.h:263
usbcsource_get_pdo_config
uint8_t usbcsource_get_pdo_config(usbcsource_t *ctx, uint8_t pdo_numb, pdo_config_t *pdo_cfg_data)
Get PDO configuration function.
fault_status_t::vpu_ovp_fault_trans
uint8_t vpu_ovp_fault_trans
Definition: usbcsource.h:346
port_status_t::vconn_mode
uint8_t vconn_mode
Definition: usbcsource.h:311
fault_status_t::th_145_status
uint8_t th_145_status
Definition: usbcsource.h:345
usbcsource_get_alert_status
void usbcsource_get_alert_status(usbcsource_t *ctx, alert_status_t *alert_status_data)
Get alert status function.
usbcsource_cfg_t::scl
pin_name_t scl
Definition: usbcsource.h:276
usbcsource_generic_write
err_t usbcsource_generic_write(usbcsource_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
USB-C Source I2C writing function.
pdo_config_t::dual_role_data
uint8_t dual_role_data
Definition: usbcsource.h:373
pdo_config_t::usb_suspend_support
uint8_t usb_suspend_support
Definition: usbcsource.h:370
fault_status_t::vpu_ovp_fault
uint8_t vpu_ovp_fault
Definition: usbcsource.h:351
usbcsource_set_pdo_config
uint8_t usbcsource_set_pdo_config(usbcsource_t *ctx, pdo_config_t pdo_cfg_data)
Set PDO configuration function.
usbcsource_int_pin_state
uint8_t usbcsource_int_pin_state(usbcsource_t *ctx)
Get INT pin state function.
usbcsource_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: usbcsource.h:282
pdo_config_t
USB-C Source Click PDO config object.
Definition: usbcsource.h:366
usbcsource_t::slave_address
uint8_t slave_address
Definition: usbcsource.h:266
USBCSOURCE_OK
@ USBCSOURCE_OK
Definition: usbcsource.h:386
usbcsource_get_monitoring_status
void usbcsource_get_monitoring_status(usbcsource_t *ctx, monitor_status_t *monitor_status_data)
Get monitoring status function.
usbcsource_set_alert_status
void usbcsource_set_alert_status(usbcsource_t *ctx, alert_status_t alert_status_data)
Set alert status function.
usbcsource_generic_read
err_t usbcsource_generic_read(usbcsource_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
USB-C Source I2C reading function.
pdo_config_t::dual_role_power
uint8_t dual_role_power
Definition: usbcsource.h:369
usbcsource_read_byte
uint8_t usbcsource_read_byte(usbcsource_t *ctx, uint8_t reg)
Generic read function.
fault_status_t::vconn_sw_ocp_fault_cc2
uint8_t vconn_sw_ocp_fault_cc2
Definition: usbcsource.h:356
usbcsource_return_value_t
usbcsource_return_value_t
USB-C Source Click return value data.
Definition: usbcsource.h:385
fault_status_t::vconn_sw_rvp_fault_cc2
uint8_t vconn_sw_rvp_fault_cc2
Definition: usbcsource.h:354
alert_status_t::hard_reset_al
uint8_t hard_reset_al
Definition: usbcsource.h:293
usbcsource_cfg_setup
void usbcsource_cfg_setup(usbcsource_cfg_t *cfg)
USB-C Source configuration object setup function.
usbcsource_get_fault_status
void usbcsource_get_fault_status(usbcsource_t *ctx, fault_status_t *fault_data)
Get fault status function.
connection_status_t::cc_reverse
uint8_t cc_reverse
Definition: usbcsource.h:334
usbcsource_t::rst
digital_out_t rst
Definition: usbcsource.h:257
pdo_config_t::unconstr_power
uint8_t unconstr_power
Definition: usbcsource.h:371
fault_status_t::vconn_sw_rvp_fault_trans
uint8_t vconn_sw_rvp_fault_trans
Definition: usbcsource.h:348
usbcsource_get_connection_status
void usbcsource_get_connection_status(usbcsource_t *ctx, connection_status_t *conn_data)
Get connection status function.
usbcsource_cfg_t::sda
pin_name_t sda
Definition: usbcsource.h:277
connection_status_t
USB-C Source Click connection status object.
Definition: usbcsource.h:333
pdo_config_t::fixed_supply
uint8_t fixed_supply
Definition: usbcsource.h:368
usbcsource_cfg_t
USB-C Source Click configuration object.
Definition: usbcsource.h:275