pca9685.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Gunar Schorcht
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef PCA9685_H
#define PCA9685_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"
#include "periph/pwm.h"
 
#define PCA9685_I2C_BASE_ADDR   (0x40)  
#define PCA9685_I2C_ALLCALLADDR (0x70)  
#define PCA9685_I2C_SUBADR1     (0x71)  
#define PCA9685_I2C_SUBADR2     (0x72)  
#define PCA9685_I2C_SUBADR3     (0x73)  
#define PCA9685_CHANNEL_NUM     (16U)
 
#define PCA9685_RESOLUTION      (1 << 12)
 
#define PCA9685_OSC_FREQ        (25000000)
 
#define PCA9685_EXT_FERQ_MAX    (50000000)
 
typedef enum {
    PCA9685_OK              = 0,    
    PCA9685_ERROR_I2C       = 1,    
} pca9685_error_t;
 
typedef enum {
    PCA9685_OPEN_DRAIN = 0,     
    PCA9685_TOTEM_POLE = 1,     
} pca9685_out_drv_t;
 
typedef enum {
    PCA9685_OFF = 0,      
    PCA9685_OUT_DRV = 1,  
    PCA9685_HIHGH_Z = 2,  
} pca9685_out_ne_t;
 
typedef struct {
 
    i2c_t i2c_dev;     
    uint8_t i2c_addr;  
    pwm_mode_t mode;    
    uint32_t freq;      
    uint16_t res;       
    bool inv;           
    uint32_t ext_freq;  
    gpio_t oe_pin;      
    pca9685_out_drv_t out_drv; 
    pca9685_out_ne_t  out_ne;  
} pca9685_params_t;
 
typedef struct {
 
    pca9685_params_t params;     
    bool powered_on;             
} pca9685_t;
 
#if MODULE_SAUL || DOXYGEN
typedef struct {
    const char *name;   
    unsigned int dev;   
    uint8_t channel;    
    uint16_t initial;   
} pca9685_saul_pwm_params_t;
#endif
 
int pca9685_init(pca9685_t *dev, const pca9685_params_t *params);
 
uint32_t pca9685_pwm_init(pca9685_t *dev, pwm_mode_t mode, uint32_t freq,
                                                           uint16_t res);
 
void pca9685_pwm_set(pca9685_t *dev, uint8_t channel, uint16_t value);
 
void pca9685_pwm_poweron(pca9685_t *dev);
 
void pca9685_pwm_poweroff(pca9685_t *dev);
 
static inline uint8_t pca9685_pwm_channels(pca9685_t *dev)
{
    (void)dev;
    return PCA9685_CHANNEL_NUM;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* PCA9685_H */