driver_pcf8574.c

Go to the documentation of this file.

 
#include "driver_pcf8574.h"

#define CHIP_NAME                 "NXP PCF8574"        
#define MANUFACTURER_NAME         "NXP"                
#define SUPPLY_VOLTAGE_MIN        2.5f                 
#define SUPPLY_VOLTAGE_MAX        6.0f                 
#define MAX_CURRENT               80.0f                
#define TEMPERATURE_MIN           -40.0f               
#define TEMPERATURE_MAX           85.0f                
#define DRIVER_VERSION            1000                 

uint8_t pcf8574_set_addr_pin(pcf8574_handle_t *handle, pcf8574_address_t addr_pin)
{
    if (handle == NULL)                                  /* check handle */
    {
        return 2;                                        /* return error */
    }
 
    handle->iic_addr = 0x40;                             /* set iic addr */
    handle->iic_addr |= (uint8_t)(addr_pin << 1);        /* set iic address */
    
    return 0;                                            /* success return 0 */
}

uint8_t pcf8574_get_addr_pin(pcf8574_handle_t *handle, pcf8574_address_t *addr_pin)
{
    if (handle == NULL)                                                        /* check handle */
    {
        return 2;                                                              /* return error */
    }
 
    *addr_pin = (pcf8574_address_t)((handle->iic_addr & (~0x40)) >> 1);        /*get iic address */
    
    return 0;                                                                  /* success return 0 */
}

uint8_t pcf8574_init(pcf8574_handle_t *handle)
{
    uint8_t data;
    
    if (handle == NULL)                                                  /* check handle */
    {
        return 2;                                                        /* return error */
    }
    if (handle->debug_print == NULL)                                     /* check debug_print */
    {
        return 3;                                                        /* return error */
    }
    if (handle->iic_init == NULL)                                        /* check iic_init */
    {
        handle->debug_print("pcf8574: iic_init is null.\n");             /* iic_init is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->iic_deinit == NULL)                                      /* check iic_deinit */
    {
        handle->debug_print("pcf8574: iic_deinit is null.\n");           /* iic_deinit is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->iic_read_cmd == NULL)                                    /* check iic_read_cmd */
    {
        handle->debug_print("pcf8574: iic_read_cmd is null.\n");         /* iic_read_cmd is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->iic_write_cmd == NULL)                                   /* check iic_write_cmd */
    {
        handle->debug_print("pcf8574: iic_write_cmd is null.\n");        /* iic_write_cmd is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->delay_ms == NULL)                                        /* check delay_ms */
    {
        handle->debug_print("pcf8574: delay_ms is null.\n");             /* delay_ms is null */
       
        return 3;                                                        /* return error */
    }
    
    if (handle->iic_init() != 0)                                         /* iic init */
    {
        handle->debug_print("pcf8574: iic init failed.\n");              /* iic init failed */
       
        return 1;                                                        /* return error */
    }
    data = 0xFF;                                                         /* set 0xFF */
    if (handle->iic_write_cmd(handle->iic_addr, 
                             (uint8_t *)&data, 1) != 0)                  /* write all pin high level */
    {
        handle->debug_print("pcf8574: iic write failed.\n");             /* iic write failed */
        (void)handle->iic_deinit();                                      /* iic deinit */
        
        return 4;                                                        /* return error */
    }
    handle->output_shadow = 0xFF;                                        /* set 0xFF */
    handle->inited = 1;                                                  /* flag finish initialization */
    
    return 0;                                                            /* success return 0 */
}

uint8_t pcf8574_deinit(pcf8574_handle_t *handle)
{
    uint8_t res;
    
    if (handle == NULL)                                              /* check handle */
    {
        return 2;                                                    /* return error */
    }
    if (handle->inited != 1)                                         /* check handle initialization */
    {
        return 3;                                                    /* return error */
    }
    
    res = handle->iic_deinit();                                      /* iic deinit */
    if (res != 0)                                                    /* check error */
    {
        handle->debug_print("pcf8574: iic deinit failed.\n");        /* iic deinit failed */
       
        return 1;                                                    /* return error */
    }
    handle->inited = 0;                                              /* flag closed */
    
    return 0;                                                        /* success return 0 */
}

uint8_t pcf8574_read(pcf8574_handle_t *handle, pcf8574_pin_t pin, pcf8574_pin_level_t *level)
{
    uint8_t res;
    uint8_t data;
    
    if (handle == NULL)                                                       /* check handle */
    {
        return 2;                                                             /* return error */
    }
    if (handle->inited != 1)                                                  /* check handle initialization */
    {
        return 3;                                                             /* return error */
    }
    
    res = handle->iic_read_cmd(handle->iic_addr, (uint8_t *)&data, 1);        /* read data */
    if (res != 0)                                                             /* check error */
    {
        handle->debug_print("pcf8574: iic read failed.\n");                   /* iic read failed */
       
        return 1;                                                             /* return error */
    }
    *level = (pcf8574_pin_level_t)((data >> pin) & 0x01);                     /* get level */
    
    return 0;                                                                 /* success return 0 */
}

uint8_t pcf8574_write(pcf8574_handle_t *handle, pcf8574_pin_t pin, pcf8574_pin_level_t level)
{
    uint8_t res;
    
    if (handle == NULL)                                                                         /* check handle */
    {
        return 2;                                                                               /* return error */
    }
    if (handle->inited != 1)                                                                    /* check handle initialization */
    {
        return 3;                                                                               /* return error */
    }
    
    handle->output_shadow &= ~(1 << pin);                                                       /* clear 0 */
    handle->output_shadow |= level << pin;                                                      /* set data */
    res = handle->iic_write_cmd(handle->iic_addr, (uint8_t *)&handle->output_shadow, 1);        /* write data */
    if (res != 0)                                                                               /* check error */
    {
        handle->debug_print("pcf8574: iic write failed.\n");                                    /* iic write failed */
       
        return 1;                                                                               /* return error */
    }
    
    return 0;                                                                                   /* success return 0 */
}

uint8_t pcf8574_set_reg(pcf8574_handle_t *handle, uint8_t *buf, uint16_t len)
{
    if (handle == NULL)                                                /* check handle */
    {
        return 2;                                                      /* return error */
    }
    if (handle->inited != 1)                                           /* check handle initialization */
    {
        return 3;                                                      /* return error */
    }
    
    if (handle->iic_write_cmd(handle->iic_addr, buf, len) != 0)        /* write command */
    {
        return 1;                                                      /* return error */
    }
    else
    {
        return 0;                                                      /* success return 0 */
    }
}

uint8_t pcf8574_get_reg(pcf8574_handle_t *handle, uint8_t *buf, uint16_t len)
{
    if (handle == NULL)                                               /* check handle */
    {
        return 2;                                                     /* return error */
    }
    if (handle->inited != 1)                                          /* check handle initialization */
    {
        return 3;                                                     /* return error */
    }
    
    if (handle->iic_read_cmd(handle->iic_addr, buf, len) != 0)        /* read command */
    {
        return 1;                                                     /* return error */
    }
    else
    {
        return 0;                                                     /* success return 0 */
    }
}

uint8_t pcf8574_info(pcf8574_info_t *info)
{
    if (info == NULL)                                               /* check handle */
    {
        return 2;                                                   /* return error */
    }
    
    memset(info, 0, sizeof(pcf8574_info_t));                        /* initialize pcf8574 info structure */
    strncpy(info->chip_name, CHIP_NAME, 32);                        /* copy chip name */
    strncpy(info->manufacturer_name, MANUFACTURER_NAME, 32);        /* copy manufacturer name */
    strncpy(info->interface, "IIC", 8);                             /* copy interface name */
    info->supply_voltage_min_v = SUPPLY_VOLTAGE_MIN;                /* set minimal supply voltage */
    info->supply_voltage_max_v = SUPPLY_VOLTAGE_MAX;                /* set maximum supply voltage */
    info->max_current_ma = MAX_CURRENT;                             /* set maximum current */
    info->temperature_max = TEMPERATURE_MAX;                        /* set minimal temperature */
    info->temperature_min = TEMPERATURE_MIN;                        /* set maximum temperature */
    info->driver_version = DRIVER_VERSION;                          /* set driver version */
    
    return 0;                                                       /* success return 0 */
}