libmcp2221.h

Go to the documentation of this file.

/*
 * Project: MCP2221 HID Library
 * Author: Zak Kemble, contact@zakkemble.co.uk
 * Copyright: (C) 2015 by Zak Kemble
 * License: GNU GPL v3 (see License.txt)
 * Web: http://blog.zakkemble.co.uk/mcp2221-hid-library/
 */

#ifndef LIBMCP2221_H_
#define LIBMCP2221_H_

#include <stdint.h>
#include <wchar.h>

#define MCP2221_STR_LEN     31  
#define MCP2221_GPIO_COUNT  4   
#define MCP2221_DAC_MAX     31  
#define MCP2221_ADC_COUNT   3   
#define MCP2221_DEFAULT_VID     0x04D8  
#define MCP2221_DEFAULT_PID     0x00DD  
#define MCP2221_DEFAULT_MANUFACTURER    L"Microchip Technology Inc."    
#define MCP2221_DEFAULT_PRODUCT         L"MCP2221 USB-I2C/UART Combo"   
#define MCP2221_REPORT_SIZE 64  
typedef enum
{
    MCP2221_SUCCESS = 0,        
    MCP2221_ERROR = -1,         
    MCP2221_INVALID_ARG = -2,   
    MCP2221_ERROR_HID = -3      
}mcp2221_error;

typedef enum
{
    MCP2221_I2C_IDLE = 0,
    MCP2221_I2C_ADDRNOTFOUND = 37, // WR NACK
    MCP2221_I2C_DATAREADY = 85,
    MCP2221_I2C_UNKNOWN1 = 98 // stop timeout
}mcp2221_i2c_state_t;

typedef enum
{
    MCP2221_DAC_REF_4096 = 7,   
    MCP2221_DAC_REF_2048 = 5,   
    MCP2221_DAC_REF_1024 = 3,   
    MCP2221_DAC_REF_OFF = 1,    
    MCP2221_DAC_REF_VDD = 0     
}mcp2221_dac_ref_t;

typedef enum
{
    MCP2221_ADC_REF_4096 = 7,   
    MCP2221_ADC_REF_2048 = 5,   
    MCP2221_ADC_REF_1024 = 3,   
    MCP2221_ADC_REF_OFF = 1,    
    MCP2221_ADC_REF_VDD = 0     
}mcp2221_adc_ref_t;

typedef enum
{
    MCP2221_INT_TRIG_INVALID = 0,           
    MCP2221_INT_TRIG_RISING = 0b00001000,   
    MCP2221_INT_TRIG_FALLING = 0b00000010,  
    MCP2221_INT_TRIG_BOTH = 0b00001010          // TODO maybe just OR the 2 values above?
}mcp2221_int_trig_t;

typedef enum
{
    MCP2221_GPIO_MODE_GPIO = 0,         
    MCP2221_GPIO_MODE_DEDI = 1,         
    MCP2221_GPIO_MODE_ALT1 = 2,         
    MCP2221_GPIO_MODE_ALT2 = 3,         
    MCP2221_GPIO_MODE_ALT3 = 4,         
    MCP2221_GPIO_MODE_INVALID = 0xff    
}mcp2221_gpio_mode_t;

#define MCP2221_GPIO_MODE_SSPND MCP2221_GPIO_MODE_DEDI  
#define MCP2221_GPIO_MODE_ADC   MCP2221_GPIO_MODE_ALT1  
#define MCP2221_GPIO_MODE_DAC   MCP2221_GPIO_MODE_ALT2  
#define MCP2221_GPIO_MODE_IOC   MCP2221_GPIO_MODE_ALT3  
typedef enum
{
    MCP2221_GPIO_VALUE_HIGH = 1,        
    MCP2221_GPIO_VALUE_LOW = 0,         
    MCP2221_GPIO_VALUE_INVALID = 0xEE   
}mcp2221_gpio_value_t;

typedef enum
{
    MCP2221_GPIO_DIR_INPUT = 1,         
    MCP2221_GPIO_DIR_OUTPUT = 0,        
    MCP2221_GPIO_DIR_INVALID = 0xEF     
}mcp2221_gpio_direction_t;

typedef enum
{
    MCP2221_PWRSRC_SELFPOWERED = 0x40,
    MCP2221_PWRSRC_BUSPOWERED = 0
}mcp2221_pwrsrc_t;

typedef enum
{
    MCP2221_WAKEUP_DISABLED = 0,    
    MCP2221_WAKEUP_ENABLED = 0x20   
}mcp2221_wakeup_t;

typedef enum
{
    MCP2221_CLKDIV_RESERVED = 0,    
    MCP2221_CLKDIV_2 = 1,           
    MCP2221_CLKDIV_4 = 2,           
    MCP2221_CLKDIV_8 = 3,           
    MCP2221_CLKDIV_16 = 4,          
    MCP2221_CLKDIV_32 = 5,          
    MCP2221_CLKDIV_64 = 6,          
    MCP2221_CLKDIV_128 = 7,         
}mcp2221_clkdiv_t;

typedef enum
{
    MCP2221_CLKDUTY_0 = 0x00,       
    MCP2221_CLKDUTY_25 = 0x08,      
    MCP2221_CLKDUTY_50 = 0x10,      
    MCP2221_CLKDUTY_75 = 0x18       
}mcp2221_clkduty_t;

typedef enum
{
    MCP2221_I2CRW_NORMAL = 0,
    MCP2221_I2CRW_REPEATED = 1,
    MCP2221_I2CRW_NOSTOP = 2
}mcp2221_i2crw_t;

typedef enum
{
    MCP2221_DEDIPIN_LEDUARTRX = 6,
    MCP2221_DEDIPIN_LEDUARTTX = 5,
    MCP2221_DEDIPIN_LEDI2C = 4,
    MCP2221_DEDIPIN_SSPND = 3,
    MCP2221_DEDIPIN_USBCFG = 2
}mcp2221_dedipin_t;

typedef enum
{
    MCP2221_GPIO0 = 1,  
    MCP2221_GPIO1 = 2,  
    MCP2221_GPIO2 = 4,  
    MCP2221_GPIO3 = 8   
}mcp2221_gpio_t;



typedef struct{
    wchar_t manufacturer[MCP2221_STR_LEN];  
    wchar_t product[MCP2221_STR_LEN];       
    wchar_t serial[MCP2221_STR_LEN];        
    uint8_t factorySerialLen;               
    char factorySerial[60];                 
    char firmware[2];                       
    char hardware[2];                       
    int vid;                                
    int pid;                                
    mcp2221_pwrsrc_t powerSource;           
    mcp2221_wakeup_t remoteWakeup;          
    int milliamps;                          
}mcp2221_usbinfo_t;

typedef struct{
    void* handle;   
    char* path;     
    uint8_t gpioCache[MCP2221_GPIO_COUNT];  
    mcp2221_usbinfo_t usbInfo;
}mcp2221_t;

typedef struct{
    uint8_t SCL;    
    uint8_t SDA;    
}mcp2221_i2cpins_t;

typedef struct{
    int gpios;                           // TODO: change to mcp2221_gpio_t ?
    mcp2221_gpio_mode_t mode;           
    mcp2221_gpio_direction_t direction; 
    mcp2221_gpio_value_t value;         
}mcp2221_gpioconf_t;

// Can't return arrays as value from funcs, but can return structs
typedef struct{
    mcp2221_gpioconf_t conf[MCP2221_GPIO_COUNT];
}mcp2221_gpioconfset_t;




#if defined(__cplusplus)
extern "C" {
#endif

mcp2221_error mcp2221_init(void);

void mcp2221_exit(void);

int mcp2221_find(int vid, int pid, wchar_t* manufacturer, wchar_t* product, wchar_t* serial);

int mcp2221_sameDevice(mcp2221_t* dev1, mcp2221_t* dev2);

mcp2221_t* mcp2221_open(void);

mcp2221_t* mcp2221_open_byIndex(int idx);

mcp2221_t* mcp2221_open_bySerial(wchar_t* serial);

void mcp2221_close(mcp2221_t* device);

mcp2221_error mcp2221_reset(mcp2221_t* device);

mcp2221_error mcp2221_isConnected(mcp2221_t* device);

mcp2221_error mcp2221_rawReport(mcp2221_t* device, uint8_t* report);

mcp2221_gpioconfset_t mcp2221_GPIOConfInit(void);

mcp2221_error mcp2221_setClockOut(mcp2221_t* device, mcp2221_clkdiv_t div, mcp2221_clkduty_t duty);

mcp2221_error mcp2221_setDAC(mcp2221_t* device, mcp2221_dac_ref_t ref, int value);

mcp2221_error mcp2221_setADC(mcp2221_t* device, mcp2221_adc_ref_t ref);

mcp2221_error mcp2221_setInterrupt(mcp2221_t* device, mcp2221_int_trig_t trig, int clearInt);

mcp2221_error mcp2221_setGPIOConf(mcp2221_t* device, mcp2221_gpioconfset_t* confSet);

mcp2221_error mcp2221_setGPIO(mcp2221_t* device, mcp2221_gpio_t pins, mcp2221_gpio_value_t value);

mcp2221_error mcp2221_getClockOut(mcp2221_t* device, mcp2221_clkdiv_t* div, mcp2221_clkduty_t* duty);

mcp2221_error mcp2221_getDAC(mcp2221_t* device, mcp2221_dac_ref_t* ref, int* value);

mcp2221_error mcp2221_getADC(mcp2221_t* device, mcp2221_adc_ref_t* ref);

mcp2221_error mcp2221_getInterrupt(mcp2221_t* device, mcp2221_int_trig_t* trig);

mcp2221_error mcp2221_getGPIO(mcp2221_t* device, mcp2221_gpioconfset_t* confGet);

mcp2221_error mcp2221_readADC(mcp2221_t* device, int values[MCP2221_ADC_COUNT]);

mcp2221_error mcp2221_readInterrupt(mcp2221_t* device, int* state);

mcp2221_error mcp2221_clearInterrupt(mcp2221_t* device);

mcp2221_error mcp2221_readGPIO(mcp2221_t* device, mcp2221_gpio_value_t values[MCP2221_GPIO_COUNT]);

mcp2221_error mcp2221_saveManufacturer(mcp2221_t* device, wchar_t* buffer);

mcp2221_error mcp2221_saveProduct(mcp2221_t* device, wchar_t* buffer);

mcp2221_error mcp2221_saveSerial(mcp2221_t* device, wchar_t* buffer);

mcp2221_error mcp2221_saveVIDPID(mcp2221_t* device, int vid, int pid);

mcp2221_error mcp2221_saveSerialEnumerate(mcp2221_t* device, int enumerate);

mcp2221_error mcp2221_saveMilliamps(mcp2221_t* device, int milliamps);

mcp2221_error mcp2221_savePowerSource(mcp2221_t* device, mcp2221_pwrsrc_t source);

mcp2221_error mcp2221_saveRemoteWakeup(mcp2221_t* device, mcp2221_wakeup_t wakeup);

mcp2221_error mcp2221_savePolarity(mcp2221_t* device, mcp2221_dedipin_t pin, int polarity);

mcp2221_error mcp2221_saveClockOut(mcp2221_t* device, mcp2221_clkdiv_t div, mcp2221_clkduty_t duty);

mcp2221_error mcp2221_saveDAC(mcp2221_t* device, mcp2221_dac_ref_t ref, int value);

mcp2221_error mcp2221_saveADC(mcp2221_t* device, mcp2221_adc_ref_t ref);

mcp2221_error mcp2221_saveInterrupt(mcp2221_t* device, mcp2221_int_trig_t trig);

mcp2221_error mcp2221_saveGPIOConf(mcp2221_t* device, mcp2221_gpioconfset_t* confSet);

mcp2221_error mcp2221_loadManufacturer(mcp2221_t* device, wchar_t* buffer);

mcp2221_error mcp2221_loadProduct(mcp2221_t* device, wchar_t* buffer);

mcp2221_error mcp2221_loadSerial(mcp2221_t* device, wchar_t* buffer);

mcp2221_error mcp2221_loadVIDPID(mcp2221_t* device, int* vid, int* pid);

mcp2221_error mcp2221_loadSerialEnumerate(mcp2221_t* device, int* enumerate);

mcp2221_error mcp2221_loadMilliamps(mcp2221_t* device, int* milliamps);

mcp2221_error mcp2221_loadPowerSource(mcp2221_t* device, mcp2221_pwrsrc_t* source);

mcp2221_error mcp2221_loadRemoteWakeup(mcp2221_t* device, mcp2221_wakeup_t* wakeup);

mcp2221_error mcp2221_loadPolarity(mcp2221_t* device, mcp2221_dedipin_t pin, int* polarity);

mcp2221_error mcp2221_loadClockOut(mcp2221_t* device, mcp2221_clkdiv_t* div, mcp2221_clkduty_t* duty);

mcp2221_error mcp2221_loadDAC(mcp2221_t* device, mcp2221_dac_ref_t* ref, int* value);

mcp2221_error mcp2221_loadADC(mcp2221_t* device, mcp2221_adc_ref_t* ref);

mcp2221_error mcp2221_loadInterrupt(mcp2221_t* device, mcp2221_int_trig_t* trig);

mcp2221_error mcp2221_loadGPIOConf(mcp2221_t* device, mcp2221_gpioconfset_t* confSet);

mcp2221_error mcp2221_i2cWrite(mcp2221_t* device, int address, void* data, int len, mcp2221_i2crw_t type);

mcp2221_error mcp2221_i2cRead(mcp2221_t* device, int address, int len, mcp2221_i2crw_t type);

mcp2221_error mcp2221_i2cGet(mcp2221_t* device, void* data, int len);

mcp2221_error mcp2221_i2cCancel(mcp2221_t* device);

mcp2221_error mcp2221_i2cState(mcp2221_t* device, mcp2221_i2c_state_t* state);

mcp2221_error mcp2221_i2cDivider(mcp2221_t* device, int i2cdiv);

mcp2221_error mcp2221_i2cReadPins(mcp2221_t* device, mcp2221_i2cpins_t* pins);

#if defined(__cplusplus)
}
#endif

#endif /* LIBMCP2221_H_ */