usbcsink2  2.1.0.0
usbcsink2.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 USBCSINK2_H
29 #define USBCSINK2_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_analog_in.h"
38 #include "drv_i2c_master.h"
39 
60 #define USBCSINK2_CMD_SRCPDO 0x00
61 #define USBCSINK2_CMD_PDONUM 0x1C
62 #define USBCSINK2_CMD_STATUS 0x1D
63 #define USBCSINK2_CMD_MASK 0x1E
64 #define USBCSINK2_CMD_VOLTAGE 0x20
65 #define USBCSINK2_CMD_CURRENT 0x21
66 #define USBCSINK2_CMD_TEMP 0x22
67 #define USBCSINK2_CMD_OCPTHR 0x23
68 #define USBCSINK2_CMD_OTPTHR 0x24
69 #define USBCSINK2_CMD_DRTHR 0x25
70 #define USBCSINK2_CMD_TR25 0x28
71 #define USBCSINK2_CMD_TR50 0x2A
72 #define USBCSINK2_CMD_TR75 0x2C
73 #define USBCSINK2_CMD_TR100 0x2E
74 #define USBCSINK2_CMD_RDO 0x30
75  // usbcsink2_reg
77 
92 #define USBCSINK2_SRCPDO_LENGTH 28
93 #define USBCSINK2_RDO_LENGTH 4
94 
99 #define USBCSINK2_RDO_REQ_SUCCESS 0x03
100 
105 #define USBCSINK2_SENS_VTG_MV 80.0f
106 #define USBCSINK2_SENS_CURRENT_MA 24.0f
107 
112 #define USBCSINK2_ADC_RESOLUTION 0x0FFF
113 #define USBCSINK2_VREF_3V3 3.3
114 #define USBCSINK2_VREF_5V 5.0
115 
121 #define USBCSINK2_SET_DEV_ADDR 0x51
122  // usbcsink2_set
124 
139 #define USBCSINK2_MAP_MIKROBUS( cfg, mikrobus ) \
140  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
141  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
142  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
143  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
144  // usbcsink2_map // usbcsink2
147 
152 typedef struct
153 {
154  digital_in_t int_pin;
156  analog_in_t adc;
157  i2c_master_t i2c;
159  uint8_t slave_address;
160  float vref;
163  uint8_t pdo_data[ 28 ];
165 } usbcsink2_t;
166 
171 typedef struct
172 {
173  pin_name_t an;
174  pin_name_t scl;
175  pin_name_t sda;
177  pin_name_t int_pin;
179  analog_in_resolution_t resolution;
180  float vref;
182  uint32_t i2c_speed;
183  uint8_t i2c_address;
186 
191 typedef enum
192 {
194  USBCSINK2_ERROR = -1
195 
197 
214 
229 
243 
259 err_t usbcsink2_generic_write ( usbcsink2_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
260 
276 err_t usbcsink2_generic_read ( usbcsink2_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len );
277 
289 err_t usbcsink2_read_raw_adc ( usbcsink2_t *ctx, uint16_t *raw_adc );
290 
302 err_t usbcsink2_read_voltage ( usbcsink2_t *ctx, float *voltage );
303 
315 err_t usbcsink2_set_vref ( usbcsink2_t *ctx, float vref );
316 
331 err_t usbcsink2_read_pdo ( usbcsink2_t *ctx, uint8_t *pdo );
332 
346 err_t usbcsink2_get_pdo_num ( usbcsink2_t *ctx, uint8_t *pdo_num );
347 
361 err_t usbcsink2_read_status ( usbcsink2_t *ctx, uint8_t *status );
362 
377 
391 err_t usbcsink2_get_pdo_voltage ( usbcsink2_t *ctx, float *voltage_mv );
392 
406 err_t usbcsink2_get_pdo_current ( usbcsink2_t *ctx, float *current_ma );
407 
421 err_t usbcsink2_get_temperature ( usbcsink2_t *ctx, uint8_t *temperature );
422 
437 err_t usbcsink2_write_rdo ( usbcsink2_t *ctx, uint8_t *rdo );
438 
453 
467 
468 #ifdef __cplusplus
469 }
470 #endif
471 #endif // USBCSINK2_H
472  // usbcsink2
474 
475 // ------------------------------------------------------------------------ END
usbcsink2_t
USB-C Sink 2 Click context object.
Definition: usbcsink2.h:153
usbcsink2_cfg_t::int_pin
pin_name_t int_pin
Definition: usbcsink2.h:177
usbcsink2_get_pdo_num
err_t usbcsink2_get_pdo_num(usbcsink2_t *ctx, uint8_t *pdo_num)
USB-C Sink 2 PDO number reading function.
usbcsink2_cfg_t::i2c_address
uint8_t i2c_address
Definition: usbcsink2.h:183
usbcsink2_cfg_setup
void usbcsink2_cfg_setup(usbcsink2_cfg_t *cfg)
USB-C Sink 2 configuration object setup function.
usbcsink2_get_pdo_voltage
err_t usbcsink2_get_pdo_voltage(usbcsink2_t *ctx, float *voltage_mv)
USB-C Sink 2 get the voltage function.
usbcsink2_cfg_t
USB-C Sink 2 Click configuration object.
Definition: usbcsink2.h:172
usbcsink2_cfg_t::vref
float vref
Definition: usbcsink2.h:180
usbcsink2_init
err_t usbcsink2_init(usbcsink2_t *ctx, usbcsink2_cfg_t *cfg)
USB-C Sink 2 initialization function.
usbcsink2_get_interrupt
uint8_t usbcsink2_get_interrupt(usbcsink2_t *ctx)
USB-C Sink 2 get interrupt function.
usbcsink2_get_pdo_current
err_t usbcsink2_get_pdo_current(usbcsink2_t *ctx, float *current_ma)
USB-C Sink 2 get the current function.
usbcsink2_reset
err_t usbcsink2_reset(usbcsink2_t *ctx)
USB-C Sink 2 hard reset the RDO function.
usbcsink2_generic_read
err_t usbcsink2_generic_read(usbcsink2_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len)
USB-C Sink 2 data reading function.
usbcsink2_t::slave_address
uint8_t slave_address
Definition: usbcsink2.h:159
usbcsink2_t::number_of_valid_pdo
uint8_t number_of_valid_pdo
Definition: usbcsink2.h:162
usbcsink2_return_value_t
usbcsink2_return_value_t
USB-C Sink 2 Click return value data.
Definition: usbcsink2.h:192
USBCSINK2_ERROR
@ USBCSINK2_ERROR
Definition: usbcsink2.h:194
usbcsink2_cfg_t::sda
pin_name_t sda
Definition: usbcsink2.h:175
usbcsink2_t::vref
float vref
Definition: usbcsink2.h:160
usbcsink2_read_status
err_t usbcsink2_read_status(usbcsink2_t *ctx, uint8_t *status)
USB-C Sink 2 status reading function.
usbcsink2_default_cfg
err_t usbcsink2_default_cfg(usbcsink2_t *ctx)
USB-C Sink 2 default configuration function.
usbcsink2_read_pdo
err_t usbcsink2_read_pdo(usbcsink2_t *ctx, uint8_t *pdo)
USB-C Sink 2 PDO data reading function.
usbcsink2_wait_rdo_req_success
err_t usbcsink2_wait_rdo_req_success(usbcsink2_t *ctx)
USB-C Sink 2 wait RDO request function.
USBCSINK2_OK
@ USBCSINK2_OK
Definition: usbcsink2.h:193
usbcsink2_cfg_t::an
pin_name_t an
Definition: usbcsink2.h:173
usbcsink2_cfg_t::resolution
analog_in_resolution_t resolution
Definition: usbcsink2.h:179
usbcsink2_generic_write
err_t usbcsink2_generic_write(usbcsink2_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len)
USB-C Sink 2 data writing function.
usbcsink2_cfg_t::scl
pin_name_t scl
Definition: usbcsink2.h:174
usbcsink2_t::int_pin
digital_in_t int_pin
Definition: usbcsink2.h:154
usbcsink2_write_rdo
err_t usbcsink2_write_rdo(usbcsink2_t *ctx, uint8_t *rdo)
USB-C Sink 2 write the RDO function.
usbcsink2_get_temperature
err_t usbcsink2_get_temperature(usbcsink2_t *ctx, uint8_t *temperature)
USB-C Sink 2 get the temperature function.
usbcsink2_read_voltage
err_t usbcsink2_read_voltage(usbcsink2_t *ctx, float *voltage)
USB-C Sink 2 read voltage level function.
usbcsink2_t::adc
analog_in_t adc
Definition: usbcsink2.h:156
usbcsink2_read_raw_adc
err_t usbcsink2_read_raw_adc(usbcsink2_t *ctx, uint16_t *raw_adc)
USB-C Sink 2 read raw ADC value function.
usbcsink2_t::i2c
i2c_master_t i2c
Definition: usbcsink2.h:157
usbcsink2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: usbcsink2.h:182
usbcsink2_set_vref
err_t usbcsink2_set_vref(usbcsink2_t *ctx, float vref)
USB-C Sink 2 set vref function.