driver_at24cxx.c

Go to the documentation of this file.

 
#include "driver_at24cxx.h"
 
#define CHIP_NAME                 "Microchip AT24CXX"       
#define MANUFACTURER_NAME         "Microchip"               
#define SUPPLY_VOLTAGE_MIN        1.7f                      
#define SUPPLY_VOLTAGE_MAX        5.5f                      
#define MAX_CURRENT               5.0f                      
#define TEMPERATURE_MIN           -40.0f                    
#define TEMPERATURE_MAX           85.0f                     
#define DRIVER_VERSION            2000                      
uint8_t at24cxx_init(at24cxx_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("at24cxx: iic_init is null.\n");                   /* iic_init is null */
       
        return 3;                                                              /* return error */
    }
    if (handle->iic_deinit == NULL)                                            /* check iic_deinit */
    {
        handle->debug_print("at24cxx: iic_deinit is null.\n");                 /* iic_deinit is null */
       
        return 3;                                                              /* return error */
    }
    if (handle->iic_read == NULL)                                              /* check iic_read */
    {
        handle->debug_print("at24cxx: iic_read is null.\n");                   /* iic_read is null */
       
        return 3;                                                              /* return error */
    }
    if (handle->iic_write == NULL)                                             /* check iic_write */
    {
        handle->debug_print("at24cxx: 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("at24cxx: 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("at24cxx: 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("at24cxx: delay_ms is null.\n");                   /* delay_ms is null */
       
        return 3;                                                              /* return error */
    }
 
    if (handle->iic_init() != 0)                                               /* iic init */
    {
        handle->debug_print("at24cxx: iic init failed.\n");                    /* iic init failed */
       
        return 1;                                                              /* return error */
    }
    handle->inited = 1;                                                        /* flag finish initialization */
 
    return 0;                                                                  /* success return 0 */
}
 
uint8_t at24cxx_deinit(at24cxx_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("at24cxx: iic deinit failed.\n");        /* iic deinit failed */
        
        return 1;                                                    /* return error */
    }   
    handle->inited = 0;                                              /* flag close */
    
    return 0;                                                        /* success return 0 */
}
 
uint8_t at24cxx_set_type(at24cxx_handle_t *handle, at24cxx_t type)
{
    if (handle == NULL)                 /* check handle */
    {
        return 2;                       /* return error */
    }
 
    handle->id = (uint32_t)type;        /* set id */
    
    return 0;                           /* success return 0 */
}
 
uint8_t at24cxx_get_type(at24cxx_handle_t *handle, at24cxx_t *type)
{
    if (handle == NULL)                     /* check handle */
    {
        return 2;                           /* return error */
    }
 
    *type = (at24cxx_t)(handle->id);        /* get id */
    
    return 0;                               /* success return 0 */
}
 
uint8_t at24cxx_set_addr_pin(at24cxx_handle_t *handle, at24cxx_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 at24cxx_get_addr_pin(at24cxx_handle_t *handle, at24cxx_address_t *addr_pin)
{
    if (handle == NULL)                                                        /* check handle */
    {
        return 2;                                                              /* return error */
    }
 
    *addr_pin = (at24cxx_address_t)((handle->iic_addr & (~0xA0)) >> 1);        /* get iic address */
    
    return 0;                                                                  /* success return 0 */
}
 
uint8_t at24cxx_read(at24cxx_handle_t *handle, uint32_t address, uint8_t *buf, uint16_t len)
{
    uint8_t page_remain;
    
    if (handle == NULL)                                                                                      /* check handle */
    {
        return 2;                                                                                            /* return error */
    }
    if (handle->inited != 1)                                                                                 /* check handle initialization */
    {
        return 3;                                                                                            /* return error */
    }
 
    if ((address + len) > handle->id)                                                                        /* check length */
    {
        handle->debug_print("at24cxx: read out of range.\n");                                                /* read out of range */
       
        return 4;                                                                                            /* return error */
    }
    page_remain = (uint8_t)(8 - address % 8);                                                                /* get page remain */
    if (len <= page_remain)                                                                                  /* page remain */
    {
        page_remain = (uint8_t)len;                                                                          /* set page remain */
    }
    if (handle->id > (uint32_t)AT24C16)                                                                      /* choose id to set different address */
    {
        while (1)
        {
            if (handle->iic_read_address16((uint8_t)(handle->iic_addr + ((address / 65536) << 1)), 
                                           address % 65536, buf,
                                           page_remain) != 0)                                                /* read page */
            {
                handle->debug_print("at24cxx: read failed.\n");                                              /* read failed */
               
                return 1;                                                                                    /* return error */
            }
            if (page_remain == len)                                                                          /* check break */
            {
                break;                                                                                       /* break loop */
            }
            else
            {
                address += page_remain;                                                                      /* address increase */
                buf += page_remain;                                                                          /* buffer point increase */
                len -= page_remain;                                                                          /* length decrease */
                if (len < 8)                                                                                 /* check length */
                {
                    page_remain = (uint8_t)len;                                                              /* set the reset length */
                }
                else
                {
                    page_remain = 8;                                                                         /* set page */
                }
            }
        }
    }
    else
    {
        while (1)
        {
            if (handle->iic_read((uint8_t)(handle->iic_addr + ((address / 256) << 1)), address % 256, buf,
                                  page_remain) != 0)                                                         /* read page */
            {
                handle->debug_print("at24cxx: read failed.\n");                                              /* read failed */
               
                return 1;                                                                                    /* return error */
            }
            if (page_remain == len)                                                                          /* check break */
            {
                break;                                                                                       /* break loop */
            }
            else
            {
                address += page_remain;                                                                      /* address increase */
                buf += page_remain;                                                                          /* buffer point increase */
                len -= page_remain;                                                                          /* length decrease */
                if (len < 8)                                                                                 /* check length */
                {
                    page_remain = (uint8_t)len;                                                              /* set the reset length */
                }
                else
                {
                    page_remain = 8;                                                                         /* set page */
                }
            }
        }
    }
    
    return 0;                                                                                                /* success return 0 */
}
 
uint8_t at24cxx_write(at24cxx_handle_t *handle, uint32_t address, uint8_t *buf, uint16_t len)
{
    uint8_t page_remain;
    
    if (handle == NULL)                                                                                       /* check handle */
    {
        return 2;                                                                                             /* return error */
    }
    if (handle->inited != 1)                                                                                  /* check handle initialization */
    {
        return 3;                                                                                             /* return error */
    }
 
    if ((address + len) > handle->id)                                                                         /* check length */
    {
        handle->debug_print("at24cxx: write out of range.\n");                                                /* write out of range */
       
        return 1;                                                                                             /* return error */
    }
    page_remain = (uint8_t)(8 - address % 8);                                                                 /* set page remain */
    if (len <= page_remain)                                                                                   /* check length */
    {
        page_remain = (uint8_t)len;                                                                           /* set page remain */
    }
    if (handle->id > (uint32_t)AT24C16)                                                                       /* check id */
    {
        while (1)
        {
            if (handle->iic_write_address16((uint8_t)(handle->iic_addr + ((address / 65536) << 1)), 
                                            address % 65536, buf,
                                            page_remain) != 0)                                                /* write page */
            {
                handle->debug_print("at24cxx: write failed.\n");                                              /* write failed */
               
                return 1;                                                                                     /* return error */
            }
            handle->delay_ms(6);                                                                              /* wait 6 ms */
            if (page_remain == len)                                                                           /* check break */
            {
                break;                                                                                        /* break */
            }
            else
            {
                address += page_remain;                                                                       /* address increase */
                buf += page_remain;                                                                           /* buffer point increase */
                len -= page_remain;                                                                           /* length decrease */
                if (len < 8)                                                                                  /* check length */
                {
                    page_remain = (uint8_t)len;                                                               /* set the rest length */
                }
                else
                {
                    page_remain = 8;                                                                          /* set page */
                }
            }
        }
    }
    else
    {
        while (1)
        {
            if (handle->iic_write((uint8_t)(handle->iic_addr + ((address / 256) << 1)), address % 256, buf,
                                  page_remain) != 0)                                                          /* write page */
            {
                handle->debug_print("at24cxx: write failed.\n");                                              /* write failed */
               
                return 1;                                                                                     /* return error */
            }
            handle->delay_ms(6);                                                                              /* wait 6 ms */
            if (page_remain == len)                                                                           /* check break */
            {
                break;                                                                                        /* break */
            }
            else
            {
                address += page_remain;                                                                       /* address increase */
                buf += page_remain;                                                                           /* buffer point increase */
                len -= page_remain;                                                                           /* length decrease */
                if (len < 8)                                                                                  /* check length */
                {
                    page_remain = (uint8_t)len;                                                               /* set the rest length */
                }
                else
                {
                    page_remain = 8;                                                                          /* set page */
                }
            }
        }
    }
    
    return 0;                                                                                                 /* success return 0 */
}
 
uint8_t at24cxx_info(at24cxx_info_t *info)
{
    if (info == NULL)                                               /* check handle */
    {
        return 2;                                                   /* return error */
    }
    
    memset(info, 0, sizeof(at24cxx_info_t));                        /* initialize at24cxx 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 */
}