driver_fm24clxx.c

Go to the documentation of this file.

 
#include "driver_fm24clxx.h"

#define CHIP_NAME                 "Cypress FM24CLXX"        
#define MANUFACTURER_NAME         "Cypress"                 
#define SUPPLY_VOLTAGE_MIN        2.7f                      
#define SUPPLY_VOLTAGE_MAX        3.65f                     
#define MAX_CURRENT               0.1f                      
#define TEMPERATURE_MIN           -40.0f                    
#define TEMPERATURE_MAX           85.0f                     
#define DRIVER_VERSION            1000                      

uint8_t fm24clxx_init(fm24clxx_handle_t *handle)
{
    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("fm24clxx: iic_init is null.\n");                   /* iic_init is null */
       
        return 3;                                                               /* return error */
    }
    if (handle->iic_deinit == NULL)                                             /* check iic_deinit */
    {
        handle->debug_print("fm24clxx: iic_deinit is null.\n");                 /* iic_deinit is null */
       
        return 3;                                                               /* return error */
    }
    if (handle->iic_read == NULL)                                               /* check iic_read */
    {
        handle->debug_print("fm24clxx: iic_read is null.\n");                   /* iic_read is null */
       
        return 3;                                                               /* return error */
    }
    if (handle->iic_write == NULL)                                              /* check iic_write */
    {
        handle->debug_print("fm24clxx: iic_write is null.\n");                  /* iic_write is null */
       
        return 3;                                                               /* return error */
    }
    if (handle->iic_read_address16 == NULL)                                     /* check iic_read_address16 */
    {
        handle->debug_print("fm24clxx: iic_read_address16 is null.\n");         /* iic_read_address16 is null */
       
        return 3;                                                               /* return error */
    }
    if (handle->iic_write_address16 == NULL)                                    /* check iic_write_address16 */
    {
        handle->debug_print("fm24clxx: iic_write_address16 is null.\n");        /* iic_write_address16 is null */
       
        return 3;                                                               /* return error */
    }
    if (handle->delay_ms == NULL)                                               /* check delay_ms */
    {
        handle->debug_print("fm24clxx: delay_ms is null.\n");                   /* delay_ms is null */
       
        return 3;                                                               /* return error */
    }
 
    if (handle->iic_init() != 0)                                                /* iic init */
    {
        handle->debug_print("fm24clxx: iic init failed.\n");                    /* iic init failed */
       
        return 1;                                                               /* return error */
    }
    handle->inited = 1;                                                         /* flag finish initialization */
 
    return 0;                                                                   /* success return 0 */
}

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

uint8_t fm24clxx_set_type(fm24clxx_handle_t *handle, fm24clxx_t type)
{
    if (handle == NULL)                 /* check handle */
    {
        return 2;                       /* return error */
    }
 
    handle->id = (uint16_t)type;        /* set id */
    
    return 0;                           /* success return 0 */
}

uint8_t fm24clxx_get_type(fm24clxx_handle_t *handle, fm24clxx_t *type)
{
    if (handle == NULL)                      /* check handle */
    {
        return 2;                            /* return error */
    }
 
    *type = (fm24clxx_t)(handle->id);        /* get id */
    
    return 0;                                /* success return 0 */
}

uint8_t fm24clxx_set_addr_pin(fm24clxx_handle_t *handle, fm24clxx_address_t addr_pin)
{
    if (handle == NULL)                       /* check handle */
    {
        return 2;                             /* return error */
    }
 
    handle->iic_addr = 0xA0;                  /* set iic addr */
    handle->iic_addr |= addr_pin << 1;        /* set iic address */
    
    return 0;                                 /* success return 0 */
}

uint8_t fm24clxx_get_addr_pin(fm24clxx_handle_t *handle, fm24clxx_address_t *addr_pin)
{
    if (handle == NULL)                                                         /* check handle */
    {
        return 2;                                                               /* return error */
    }
 
    *addr_pin = (fm24clxx_address_t)((handle->iic_addr & (~0xA0)) >> 1);        /* get iic address */
    
    return 0;                                                                   /* success return 0 */
}

uint8_t fm24clxx_read(fm24clxx_handle_t *handle, uint16_t address, 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 ((uint16_t)(address + len) > handle->id)                                                          /* check length */
    {
        handle->debug_print("fm24clxx: read out of range.\n");                                           /* read out of range */
       
        return 4;                                                                                        /* return error */
    }
 
    if (handle->id > (uint16_t)FM24CL16B)                                                                /* choose id to set different address */
    {
        if (handle->iic_read_address16(handle->iic_addr, address, buf, len) != 0)                        /* read data */
        {
            handle->debug_print("fm24clxx: read failed.\n");                                             /* read failed */
           
            return 1;                                                                                    /* return error */
        }
    }
    else
    {
        if (handle->iic_read((uint8_t)(handle->iic_addr + ((address / 256) << 1)), address % 256,
                              buf, len) != 0)                                                            /* read page */
        {
            handle->debug_print("fm24clxx: read failed.\n");                                             /* read failed */
           
            return 1;                                                                                    /* return error */
        }
    }
    
    return 0;                                                                                            /* success return 0 */
}

uint8_t fm24clxx_write(fm24clxx_handle_t *handle, uint16_t address, 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 ((uint16_t)(address + len) > handle->id)                                                           /* check length */
    {
        handle->debug_print("fm24clxx: write out of range.\n");                                           /* write out of range */
       
        return 4;                                                                                         /* return error */
    }
 
    if (handle->id > (uint16_t)FM24CL16B)                                                                 /* check id */
    {
        if (handle->iic_write_address16(handle->iic_addr, address, buf, len) != 0)                        /* write data */
        {
            handle->debug_print("fm24clxx: write failed.\n");                                             /* write failed */
           
            return 1;                                                                                     /* return error */
        }
    }        
    else
    {
        if (handle->iic_write((uint8_t)(handle->iic_addr + ((address / 256) << 1)), address % 256,
                               buf, len) != 0)                                                            /* write page */
        {
            handle->debug_print("fm24clxx: write failed.\n");                                             /* write failed */
           
            return 1;                                                                                     /* return error */
        }
    }
    
    return 0;                                                                                             /* success return 0 */
}

uint8_t fm24clxx_info(fm24clxx_info_t *info)
{
    if (info == NULL)                                               /* check handle */
    {
        return 2;                                                   /* return error */
    }
    
    memset(info, 0, sizeof(fm24clxx_info_t));                       /* initialize fm24clxx 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 */
}