usbcsink2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef USBCSINK2_H
#define USBCSINK2_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_i2c_master.h"
 
#define USBCSINK2_CMD_SRCPDO             0x00
#define USBCSINK2_CMD_PDONUM             0x1C
#define USBCSINK2_CMD_STATUS             0x1D
#define USBCSINK2_CMD_MASK               0x1E
#define USBCSINK2_CMD_VOLTAGE            0x20
#define USBCSINK2_CMD_CURRENT            0x21
#define USBCSINK2_CMD_TEMP               0x22
#define USBCSINK2_CMD_OCPTHR             0x23
#define USBCSINK2_CMD_OTPTHR             0x24
#define USBCSINK2_CMD_DRTHR              0x25
#define USBCSINK2_CMD_TR25               0x28
#define USBCSINK2_CMD_TR50               0x2A
#define USBCSINK2_CMD_TR75               0x2C
#define USBCSINK2_CMD_TR100              0x2E
#define USBCSINK2_CMD_RDO                0x30
 
 // usbcsink2_reg
 
#define USBCSINK2_SRCPDO_LENGTH          28
#define USBCSINK2_RDO_LENGTH             4
 
#define USBCSINK2_RDO_REQ_SUCCESS        0x03
 
#define USBCSINK2_SENS_VTG_MV            80.0f
#define USBCSINK2_SENS_CURRENT_MA        24.0f
 
#define USBCSINK2_ADC_RESOLUTION         0x0FFF
#define USBCSINK2_VREF_3V3               3.3
#define USBCSINK2_VREF_5V                5.0
 
#define USBCSINK2_SET_DEV_ADDR           0x51
 
 // usbcsink2_set
 
#define USBCSINK2_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // usbcsink2_map
 // usbcsink2
 
typedef struct
{
    digital_in_t int_pin;           
    analog_in_t  adc;               
    i2c_master_t i2c;               
    uint8_t      slave_address;     
    float        vref;              
    uint8_t number_of_valid_pdo;    
    uint8_t pdo_data[ 28 ];         
} usbcsink2_t;
 
typedef struct
{
    pin_name_t an;     
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t int_pin;    
    analog_in_resolution_t resolution;    
    float                  vref;          
    uint32_t               i2c_speed;      
    uint8_t                i2c_address;    
} usbcsink2_cfg_t;
 
typedef enum
{
    USBCSINK2_OK = 0,
    USBCSINK2_ERROR = -1
 
} usbcsink2_return_value_t;
 
void usbcsink2_cfg_setup ( usbcsink2_cfg_t *cfg );
 
err_t usbcsink2_init ( usbcsink2_t *ctx, usbcsink2_cfg_t *cfg );
 
err_t usbcsink2_default_cfg ( usbcsink2_t *ctx );
 
err_t usbcsink2_generic_write ( usbcsink2_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
 
err_t usbcsink2_generic_read ( usbcsink2_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len );
 
err_t usbcsink2_read_raw_adc ( usbcsink2_t *ctx, uint16_t *raw_adc );
 
err_t usbcsink2_read_voltage ( usbcsink2_t *ctx, float *voltage );
 
err_t usbcsink2_set_vref ( usbcsink2_t *ctx, float vref );
 
err_t usbcsink2_read_pdo ( usbcsink2_t *ctx, uint8_t *pdo );
 
err_t usbcsink2_get_pdo_num ( usbcsink2_t *ctx, uint8_t *pdo_num );
 
err_t usbcsink2_read_status ( usbcsink2_t *ctx, uint8_t *status );
 
err_t usbcsink2_wait_rdo_req_success ( usbcsink2_t *ctx );
 
err_t usbcsink2_get_pdo_voltage ( usbcsink2_t *ctx, float *voltage_mv );
 
err_t usbcsink2_get_pdo_current ( usbcsink2_t *ctx, float *current_ma );
 
err_t usbcsink2_get_temperature ( usbcsink2_t *ctx, uint8_t *temperature );
 
err_t usbcsink2_write_rdo ( usbcsink2_t *ctx, uint8_t *rdo );
 
err_t usbcsink2_reset ( usbcsink2_t *ctx );
 
uint8_t usbcsink2_get_interrupt ( usbcsink2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // USBCSINK2_H
 
 // usbcsink2
 
// ------------------------------------------------------------------------ END