mcp2221.h

Go to the documentation of this file.

 
#ifndef MCP2221_H
#define MCP2221_H
 
#include <stddef.h>
#include <stdint.h>
#include "mcp2221_export.h"
#include "mcp2221_error_codes.h"
#include "mcp2221_errors.h"
 
MCP2221_BEGIN_DECLS
 
typedef struct mcp2221_device mcp2221_t;
 
typedef struct mcp2221_i2c_slave mcp2221_i2c_slave_t;
 
typedef struct {
    uint16_t rlen;       
    uint16_t txlen;      
    uint8_t div;         
    uint8_t ack;         
    uint8_t st;          
    uint8_t scl;         
    uint8_t sda;         
    uint8_t confused;    
    uint8_t initialized; 
} mcp2221_i2c_status_t;
 
typedef struct {
    uint8_t hardware_major; 
    uint8_t hardware_minor; 
    uint8_t firmware_major; 
    uint8_t firmware_minor; 
} mcp2221_revision_t;
 
typedef enum {
    MCP2221_I2C_KIND_NORMAL = 0,         
    MCP2221_I2C_KIND_REPEATED_START = 1, 
    MCP2221_I2C_KIND_NO_STOP = 2         
} mcp2221_i2c_kind_t;
 
MCP2221_API mcp2221_error_code_t mcp2221_open(
    uint16_t vid, uint16_t pid, int devnum, const char *usbserial,
    int usb_read_timeout_ms, int cmd_retries, int debug_messages,
    int trace_packets, mcp2221_t **out_dev);
 
MCP2221_API mcp2221_error_code_t mcp2221_open_scan(
    uint16_t vid, uint16_t pid, int devnum, const char *usbserial,
    int usb_read_timeout_ms, int cmd_retries, int debug_messages,
    int trace_packets, int scan_serial, mcp2221_t **out_dev);
 
MCP2221_API mcp2221_error_code_t mcp2221_open_simple(
    uint16_t vid, uint16_t pid, int devnum, const char *usbserial,
    int i2c_speed_hz, mcp2221_t **out_dev);
 
MCP2221_API mcp2221_error_code_t mcp2221_open_simple_scan(
    uint16_t vid, uint16_t pid, int devnum, const char *usbserial,
    int i2c_speed_hz, int scan_serial, mcp2221_t **out_dev);
 
MCP2221_API void mcp2221_close(mcp2221_t *dev);
 
MCP2221_API mcp2221_error_code_t mcp2221_reset(mcp2221_t *dev);
 
MCP2221_API mcp2221_error_code_t mcp2221_send_cmd(mcp2221_t *dev, const uint8_t *buf, size_t len, uint8_t *response /* 64-Byte Buffer */);
 
MCP2221_API mcp2221_error_code_t mcp2221_i2c_set_speed(mcp2221_t *dev, uint32_t i2c_speed_hz);
 
MCP2221_API mcp2221_error_code_t mcp2221_i2c_write_ex(mcp2221_t *dev, uint8_t addr, const uint8_t *data, size_t len,
                                 mcp2221_i2c_kind_t kind, int i2c_timeout_ms);
 
MCP2221_API mcp2221_error_code_t mcp2221_i2c_write_simple(mcp2221_t *dev, uint8_t addr, const uint8_t *data, size_t len, mcp2221_i2c_kind_t kind);
 
MCP2221_API mcp2221_error_code_t mcp2221_i2c_read_ex(mcp2221_t *dev, uint8_t addr, uint8_t *data, size_t len,
                                mcp2221_i2c_kind_t kind, int i2c_timeout_ms);
 
MCP2221_API mcp2221_error_code_t mcp2221_i2c_read_simple(mcp2221_t *dev, uint8_t addr, uint8_t *data, size_t len, mcp2221_i2c_kind_t kind);
 
MCP2221_API mcp2221_error_code_t mcp2221_i2c_status(mcp2221_t *dev, mcp2221_i2c_status_t *st);
 
MCP2221_API mcp2221_error_code_t mcp2221_revision(
    mcp2221_t *dev,
    mcp2221_revision_t *revision);
 
MCP2221_API mcp2221_error_code_t mcp2221_i2c_release(mcp2221_t *dev);
 
MCP2221_END_DECLS
#endif  // MCP2221_H