usbcsink3.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 USBCSINK3_H
#define USBCSINK3_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_i2c_master.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
#include "drv_analog_in.h"
 
#define USBCSINK3_REG_INPUT_PORT             0x00
#define USBCSINK3_REG_OUTPUT_PORT            0x01
#define USBCSINK3_REG_POLARITY_INV           0x02
#define USBCSINK3_REG_CONFIG                 0x03
#define USBCSINK3_REG_SPECIAL_FUNC           0x50
 
 // usbcsink3_reg
 
#define USBCSINK3_CMD_SEL_NONE               0x00
#define USBCSINK3_CMD_SEL_DATA_WRITE         0x10
#define USBCSINK3_CMD_SEL_SHUTDOWN           0x20
 
#define USBCSINK3_POT_SEL_DUMMY_CODE         0x00
#define USBCSINK3_POT_SEL_DIGI_POT_1         0x01
#define USBCSINK3_POT_SEL_DIGI_POT_2         0x02
#define USBCSINK3_POT_SEL_DIGI_POT_BOTH      0x03
 
 // usbcsink3_cmd
 
#define USBCSINK3_NO_PIN_BIT_MASK            0x00
#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
#define USBCSINK3_DIRECTION_INPUT            0x01
 
#define USBCSINK3_VSEL0_DISABLE              0x00
#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
#define USBCSINK3_SPEC_FUNC_PU_DISABLED      0x40
 
#define USBCSINK3_VBUS_VTG_0V                0.0f
#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
#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
#define USBCSINK3_VREF_3V3                   3.3
#define USBCSINK3_VREF_5V                    5.0
 
#define USBCSINK3_DEVICE_ADDRESS             0x41
 
#define USBCSINK3_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define USBCSINK3_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // usbcsink3_set
 
#define USBCSINK3_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL );  \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA );  \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 // usbcsink3_map
 // usbcsink3
 
 
typedef struct usbcsink3_s
{
    analog_in_t  adc;     
    float        vref;    
    i2c_master_t i2c;     
    spi_master_t spi;     
    uint8_t      slave_address;    
    pin_name_t   chip_select;      
} usbcsink3_t;
 
typedef struct
{
    pin_name_t scl;     
    pin_name_t sda;     
    pin_name_t miso;    
    pin_name_t mosi;    
    pin_name_t sck;     
    pin_name_t cs;      
    pin_name_t an;      
   analog_in_resolution_t resolution;    
   float        vref;                    
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
    uint32_t                          spi_speed;      
    spi_master_mode_t                 spi_mode;       
    spi_master_chip_select_polarity_t cs_polarity;    
} usbcsink3_cfg_t;
 
typedef enum
{
    USBCSINK3_OK = 0,
    USBCSINK3_ERROR = -1
 
} usbcsink3_return_value_t;
 
typedef enum
{
    USBCSINK3_VTG_SEL_5V = 0,
    USBCSINK3_VTG_SEL_9V,
    USBCSINK3_VTG_SEL_15V,
    USBCSINK3_VTG_SEL_20V,
    USBCSINK3_VTG_SEL_4_3V,
    USBCSINK3_VTG_SEL_8_6V,
    USBCSINK3_VTG_SEL_12_9V,
    USBCSINK3_VTG_SEL_17_2V
 
} usbcsink3_vtg_sel_t;
 
typedef enum
{
    USBCSINK3_PWR_SEL_12W = 0,
    USBCSINK3_PWR_SEL_15W,
    USBCSINK3_PWR_SEL_18W,
    USBCSINK3_PWR_SEL_20W,
    USBCSINK3_PWR_SEL_27W,
    USBCSINK3_PWR_SEL_36W,
    USBCSINK3_PWR_SEL_45W,
    USBCSINK3_PWR_SEL_60W,
    USBCSINK3_PWR_SEL_90W,
    USBCSINK3_PWR_SEL_100W
 
} usbcsink3_pwr_sel_t;
 
 
void usbcsink3_cfg_setup ( usbcsink3_cfg_t *cfg );
 
err_t usbcsink3_init ( usbcsink3_t *ctx, usbcsink3_cfg_t *cfg );
 
err_t usbcsink3_default_cfg ( usbcsink3_t *ctx );
 
err_t usbcsink3_i2c_write ( usbcsink3_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t usbcsink3_i2c_read ( usbcsink3_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t usbcsink3_spi_write ( usbcsink3_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t usbcsink3_read_raw_adc ( usbcsink3_t *ctx, uint16_t *raw_adc );
 
err_t usbcsink3_read_voltage ( usbcsink3_t *ctx, float *voltage );
 
err_t usbcsink3_set_vref ( usbcsink3_t *ctx, float vref );
 
err_t usbcsink3_get_vbus ( usbcsink3_t *ctx, float *vbus );
 
err_t usbcsink3_set_wiper ( usbcsink3_t *ctx, uint8_t wiper_pos );
 
err_t usbcsink3_set_resistence ( usbcsink3_t *ctx, float resistence );
 
err_t usbcsink3_set_voltage ( usbcsink3_t *ctx, usbcsink3_vtg_sel_t voltage );
 
err_t usbcsink3_set_power ( usbcsink3_t *ctx, usbcsink3_pwr_sel_t power );
 
#ifdef __cplusplus
}
#endif
#endif // USBCSINK3_H
 
 // usbcsink3
 
// ------------------------------------------------------------------------ END