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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define USBCSOURCE_REG_ALERT_STATUS_REG 0x0B
74 #define USBCSOURCE_REG_ALERT_STATUS_MASK_CTRL 0x0C
75 #define USBCSOURCE_REG_CC_CONNECTION_STATUS_TRANS 0x0D
76 #define USBCSOURCE_REG_CC_CONNECTION_STATUS_1 0x0E
77 #define USBCSOURCE_REG_MONITORING_STATUS_TRANS 0x0F
78 #define USBCSOURCE_REG_MONITORING_STATUS 0x10
79 #define USBCSOURCE_REG_CC_CONNECTION_STATUS_2 0x11
80 #define USBCSOURCE_REG_HW_FAULT_STATUS_TRANS 0x12
81 #define USBCSOURCE_REG_HW_FAULT_STATUS 0x13
82 #define USBCSOURCE_REG_CC_CAPABILITY_CTRL 0x18
83 #define USBCSOURCE_REG_RESET_CTRL 0x23
84 #define USBCSOURCE_REG_VBUS_DISCHARGE_TIME_CTRL 0x25
85 #define USBCSOURCE_REG_VBUS_DISCHARGE_STATUS 0x26
86 #define USBCSOURCE_REG_VBUS_ENABLE_STATUS 0x27
87 #define USBCSOURCE_REG_VBUS_MONITORING_CTRL 0x2E
88 
89 #define USBCSOURCE_REG_SRC_PDO1 0x71
90 #define USBCSOURCE_REG_SRC_PDO2 0x75
91 #define USBCSOURCE_REG_SRC_PDO3 0x79
92 #define USBCSOURCE_REG_SRC_PDO4 0x7D
93 #define USBCSOURCE_REG_SRC_PDO5 0x81
94  // usbcsource_reg
96 
116 #define USBCSOURCE_SEL_PDO1 0x01
117 #define USBCSOURCE_SEL_PDO2 0x02
118 #define USBCSOURCE_SEL_PDO3 0x03
119 #define USBCSOURCE_SEL_PDO4 0x04
120 #define USBCSOURCE_SEL_PDO5 0x05
121 
126 #define USBCSOURCE_PDO_NVM_VOLT_CFG_9_V 0x00
127 #define USBCSOURCE_PDO_NVM_VOLT_CFG_15_V 0x01
128 #define USBCSOURCE_PDO_NVM_VOLT_CFG_FLEX_V1 0x02
129 #define USBCSOURCE_PDO_NVM_VOLT_CFG_FLEX_V2 0x03
130 
135 #define USBCSOURCE_PDO_NVM_CUR_FLEX_I 0x00
136 #define USBCSOURCE_PDO_NVM_CUR_1_50_A 0x01
137 #define USBCSOURCE_PDO_NVM_CUR_1_75_A 0x02
138 #define USBCSOURCE_PDO_NVM_CUR_2_00_A 0x03
139 #define USBCSOURCE_PDO_NVM_CUR_2_25_A 0x04
140 #define USBCSOURCE_PDO_NVM_CUR_2_50_A 0x05
141 #define USBCSOURCE_PDO_NVM_CUR_2_75_A 0x06
142 #define USBCSOURCE_PDO_NVM_CUR_3_00_A 0x07
143 #define USBCSOURCE_PDO_NVM_CUR_3_25_A 0x08
144 #define USBCSOURCE_PDO_NVM_CUR_3_50_A 0x09
145 #define USBCSOURCE_PDO_NVM_CUR_3_75_A 0x0A
146 #define USBCSOURCE_PDO_NVM_CUR_4_00_A 0x0B
147 #define USBCSOURCE_PDO_NVM_CUR_4_25_A 0x0C
148 #define USBCSOURCE_PDO_NVM_CUR_4_50_A 0x0D
149 #define USBCSOURCE_PDO_NVM_CUR_4_75_A 0x0E
150 #define USBCSOURCE_PDO_NVM_CUR_5_00_A 0x0F
151 
156 #define USBCSOURCE_RESET_DIS 0x00
157 #define USBCSOURCE_RESET_EN 0x01
158 
163 #define USBCSOURCE_ALERT_STAT_HARD_RESET_AL 0x80
164 #define USBCSOURCE_ALERT_STAT_PORT_STAT_AL 0x40
165 #define USBCSOURCE_ALERT_STAT_TYPEC_MON_AL 0x20
166 #define USBCSOURCE_ALERT_STAT_CC_HW_FAULT_AL 0x10
167 #define USBCSOURCE_ALERT_STAT_DPM_STAT_AL 0x08
168 #define USBCSOURCE_ALERT_STAT_PE_STAT_AL 0x04
169 #define USBCSOURCE_ALERT_STAT_PRT_STAT_AL 0x02
170 #define USBCSOURCE_ALERT_STAT_PHY_STAT_AL 0x01
171 
176 #define USBCSOURCE_ATTACHED_DEVICE_NONE_ATT 0x00
177 #define USBCSOURCE_ATTACHED_DEVICE_SNK_ATT 0x01
178 #define USBCSOURCE_ATTACHED_DEVICE_SRC_ATT 0x02
179 #define USBCSOURCE_ATTACHED_DEVICE_DBG_ATT 0x03
180 #define USBCSOURCE_ATTACHED_DEVICE_AUD_ATT 0x04
181 #define USBCSOURCE_ATTACHED_DEVICE_POW_ACC_ATT 0x05
182 
187 #define USBCSOURCE_LOW_POWER_STANDBY_OFF 0x00
188 #define USBCSOURCE_LOW_POWER_STANDBY_ON 0x01
189 
194 #define USBCSOURCE_POWER_MODE_SNK 0x00
195 #define USBCSOURCE_POWER_MODE_SRC 0x01
196 
201 #define USBCSOURCE_DATA_MODE_UFP 0x00
202 #define USBCSOURCE_DATA_MODE_DFP 0x01
203 
208 #define USBCSOURCE_CONN_UNATTACHED 0x00
209 #define USBCSOURCE_CONN_ATTACHED 0x01
210 
215 #define USBCSOURCE_VBUS_READY_DISCONNECTED 0x00
216 #define USBCSOURCE_VBUS_READY_CONNECTED 0x01
217 
218 #define USBCSOURCE_VBUS_VSAFE0V_0_8V_HIGHER 0x00
219 #define USBCSOURCE_VBUS_VSAFE0V_0_8V_LOWER 0x01
220 
221 #define USBCSOURCE_VBUS_VALID_3_9V_LOWER 0x00
222 #define USBCSOURCE_VBUS_VALID_3_9V_HIGHER 0x01
223 
228 #define USBCSOURCE_STATUS_ERROR 0x00
229 #define USBCSOURCE_STATUS_SUCCESS 0x01
230 
236 #define USBCSOURCE_I2C_SLAVE_ADR_GND 0x28
237 #define USBCSOURCE_I2C_SLAVE_ADR_VCC 0x29
238  // usbcsource_set
240 
255 #define USBCSOURCE_MAP_MIKROBUS( cfg, mikrobus ) \
256  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
257  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
258  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
259  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
260  // usbcsource_map // usbcsource
263 
268 typedef struct
269 {
270  // Output pins
271  digital_out_t rst;
273  // Input pins
274  digital_in_t int_pin;
276  // Modules
277  i2c_master_t i2c;
279  // I2C slave address
280  uint8_t slave_address;
282 } usbcsource_t;
283 
288 typedef struct
289 {
290  pin_name_t scl;
291  pin_name_t sda;
293  pin_name_t rst;
294  pin_name_t int_pin;
296  uint32_t i2c_speed;
297  uint8_t i2c_address;
300 
305 typedef struct
306 {
307  uint8_t hard_reset_al;
308  uint8_t port_status_al;
311  uint8_t prt_status_al;
312  uint8_t phy_status_al;
314 
319 typedef struct
320 {
323  uint8_t power_mode;
324  uint8_t data_mode;
325  uint8_t vconn_mode;
326  uint8_t attach;
327 } port_status_t;
328 
333 typedef struct
334 {
336  uint8_t vbus_ready;
337  uint8_t vbus_vsafe0v;
338  uint8_t vbus_valid;
339  uint8_t vconn_valid;
341 
346 typedef struct
347 {
348  uint8_t cc_reverse;
352 
357 typedef struct
358 {
359  uint8_t th_145_status;
365  uint8_t vpu_ovp_fault;
366  uint8_t vpu_valid;
374 
379 typedef struct
380 {
381  uint8_t pdo_number;
382  uint8_t fixed_supply;
385  uint8_t unconstr_power;
387  uint8_t dual_role_data;
389  uint8_t peak_current;
390  float vtg_data;
391  float curr_data;
392 } pdo_config_t;
393 
398 typedef enum
399 {
401  USBCSOURCE_ERROR = -1
402 
404 
421 
436 
451 err_t usbcsource_generic_write ( usbcsource_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
452 
467 err_t usbcsource_generic_read ( usbcsource_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
468 
481 void usbcsource_write_byte ( usbcsource_t *ctx, uint8_t reg, uint8_t tx_data );
482 
494 uint8_t usbcsource_read_byte ( usbcsource_t *ctx, uint8_t reg );
495 
507 
519 
532 void usbcsource_get_alert_status ( usbcsource_t *ctx, alert_status_t *alert_status_data );
533 
546 void usbcsource_set_alert_status ( usbcsource_t *ctx, alert_status_t alert_status_data );
547 
560 
573 void usbcsource_get_port_status ( usbcsource_t *ctx, port_status_t *port_status_data );
574 
589 
603 
618 
630 
642 uint8_t usbcsource_set_pdo_config ( usbcsource_t *ctx, pdo_config_t pdo_cfg_data );
643 
656 uint8_t usbcsource_get_pdo_config ( usbcsource_t *ctx, uint8_t pdo_numb, pdo_config_t *pdo_cfg_data );
657 
676 
677 #ifdef __cplusplus
678 }
679 #endif
680 #endif // USBCSOURCE_H
681  // usbcsource
683 
684 // ------------------------------------------------------------------------ END
fault_status_t::vconn_sw_ocp_fault_cc1
uint8_t vconn_sw_ocp_fault_cc1
Definition: usbcsource.h:369
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:339
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:269
port_status_t::attached_device
uint8_t attached_device
Definition: usbcsource.h:321
usbcsource_t::int_pin
digital_in_t int_pin
Definition: usbcsource.h:274
monitor_status_t::vbus_vsafe0v
uint8_t vbus_vsafe0v
Definition: usbcsource.h:337
fault_status_t::vconn_sw_ovp_fault_trans
uint8_t vconn_sw_ovp_fault_trans
Definition: usbcsource.h:364
pdo_config_t::unch_exd_mesg_support
uint8_t unch_exd_mesg_support
Definition: usbcsource.h:388
connection_status_t::snk_power_level
uint8_t snk_power_level
Definition: usbcsource.h:349
alert_status_t::port_status_al
uint8_t port_status_al
Definition: usbcsource.h:308
monitor_status_t::pd_typec_hand_check
uint8_t pd_typec_hand_check
Definition: usbcsource.h:335
connection_status_t::typec_fsm_state
uint8_t typec_fsm_state
Definition: usbcsource.h:350
fault_status_t::vconn_sw_ovp_fault_cc1
uint8_t vconn_sw_ovp_fault_cc1
Definition: usbcsource.h:371
alert_status_t::phy_status_al
uint8_t phy_status_al
Definition: usbcsource.h:312
pdo_config_t::vtg_data
float vtg_data
Definition: usbcsource.h:390
fault_status_t
USB-C Source Click fault status object.
Definition: usbcsource.h:358
fault_status_t::vconn_sw_ovp_fault_cc2
uint8_t vconn_sw_ovp_fault_cc2
Definition: usbcsource.h:372
port_status_t::low_power_standby
uint8_t low_power_standby
Definition: usbcsource.h:322
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:389
fault_status_t::vconn_sw_rvp_fault_cc1
uint8_t vconn_sw_rvp_fault_cc1
Definition: usbcsource.h:367
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:294
port_status_t::power_mode
uint8_t power_mode
Definition: usbcsource.h:323
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:338
pdo_config_t::usb_commun_capable
uint8_t usb_commun_capable
Definition: usbcsource.h:386
fault_status_t::vpu_valid_trans
uint8_t vpu_valid_trans
Definition: usbcsource.h:361
pdo_config_t::pdo_number
uint8_t pdo_number
Definition: usbcsource.h:381
alert_status_t::typec_monitoring_status_al
uint8_t typec_monitoring_status_al
Definition: usbcsource.h:309
fault_status_t::vconn_sw_ocp_fault_trans
uint8_t vconn_sw_ocp_fault_trans
Definition: usbcsource.h:363
fault_status_t::vpu_valid
uint8_t vpu_valid
Definition: usbcsource.h:366
port_status_t::attach
uint8_t attach
Definition: usbcsource.h:326
monitor_status_t
USB-C Source Click monitor status object.
Definition: usbcsource.h:334
alert_status_t
USB-C Source Click alert status object.
Definition: usbcsource.h:306
usbcsource_cfg_t::rst
pin_name_t rst
Definition: usbcsource.h:293
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:336
port_status_t::data_mode
uint8_t data_mode
Definition: usbcsource.h:324
pdo_config_t::curr_data
float curr_data
Definition: usbcsource.h:391
port_status_t
USB-C Source Click port status object.
Definition: usbcsource.h:320
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:311
USBCSOURCE_ERROR
@ USBCSOURCE_ERROR
Definition: usbcsource.h:401
alert_status_t::cc_hw_fault_status_al
uint8_t cc_hw_fault_status_al
Definition: usbcsource.h:310
usbcsource_cfg_t::i2c_address
uint8_t i2c_address
Definition: usbcsource.h:297
usbcsource_t::i2c
i2c_master_t i2c
Definition: usbcsource.h:277
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:360
port_status_t::vconn_mode
uint8_t vconn_mode
Definition: usbcsource.h:325
fault_status_t::th_145_status
uint8_t th_145_status
Definition: usbcsource.h:359
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:290
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:387
pdo_config_t::usb_suspend_support
uint8_t usb_suspend_support
Definition: usbcsource.h:384
fault_status_t::vpu_ovp_fault
uint8_t vpu_ovp_fault
Definition: usbcsource.h:365
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:296
pdo_config_t
USB-C Source Click PDO config object.
Definition: usbcsource.h:380
usbcsource_t::slave_address
uint8_t slave_address
Definition: usbcsource.h:280
USBCSOURCE_OK
@ USBCSOURCE_OK
Definition: usbcsource.h:400
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:383
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:370
usbcsource_return_value_t
usbcsource_return_value_t
USB-C Source Click return value data.
Definition: usbcsource.h:399
fault_status_t::vconn_sw_rvp_fault_cc2
uint8_t vconn_sw_rvp_fault_cc2
Definition: usbcsource.h:368
alert_status_t::hard_reset_al
uint8_t hard_reset_al
Definition: usbcsource.h:307
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:348
usbcsource_t::rst
digital_out_t rst
Definition: usbcsource.h:271
pdo_config_t::unconstr_power
uint8_t unconstr_power
Definition: usbcsource.h:385
fault_status_t::vconn_sw_rvp_fault_trans
uint8_t vconn_sw_rvp_fault_trans
Definition: usbcsource.h:362
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:291
connection_status_t
USB-C Source Click connection status object.
Definition: usbcsource.h:347
pdo_config_t::fixed_supply
uint8_t fixed_supply
Definition: usbcsource.h:382
usbcsource_cfg_t
USB-C Source Click configuration object.
Definition: usbcsource.h:289