driver_max7219.c

Go to the documentation of this file.

  
#include "driver_max7219.h"

#define CHIP_NAME                 "Maxim Integrated MAX7219"        
#define MANUFACTURER_NAME         "Maxim Integrated"                
#define SUPPLY_VOLTAGE_MIN        4.0f                              
#define SUPPLY_VOLTAGE_MAX        5.5f                              
#define MAX_CURRENT               320.0f                            
#define TEMPERATURE_MIN           -40.0f                            
#define TEMPERATURE_MAX           85.0f                             
#define DRIVER_VERSION            2000                              

#define MAX7219_REG_DECODE              0x09        
#define MAX7219_REG_INTENSITY           0x0A        
#define MAX7219_REG_SCAN_LIMIT          0x0B        
#define MAX7219_REG_SHUT_DOWN           0x0C        
#define MAX7219_REG_DISPLAY_TEST        0x0F        

uint8_t max7219_set_display(max7219_handle_t *handle, max7219_digital_t digital, uint8_t data)
{
    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->spi_write(digital, &data, 1);                 /* spi write data */
    if (res != 0)                                               /* check result */
    {
        handle->debug_print("max7219: write failed.\n");        /* write failed */
       
        return 1;                                               /* return error */
    }
    
    return 0;                                                   /* success return 0 */
}

uint8_t max7219_set_matrix(max7219_handle_t *handle, uint8_t matrix[8])
{
    uint8_t res;
    uint8_t i;
    
    if (handle == NULL)                                             /* check handle */
    {
        return 2;                                                   /* return error */
    }
    if (handle->inited != 1)                                        /* check handle initialization */
    {
        return 3;                                                   /* return error */
    }
    
    for (i = 0; i < 8; i++)
    {
        res = handle->spi_write(i + 1, &matrix[i], 1);              /* spi write data */
        if (res != 0)                                               /* check result */
        {
            handle->debug_print("max7219: write failed.\n");        /* write failed */
           
            return 1;                                               /* return error */
        }
    }
    
    return 0;                                                       /* success return 0 */
}

uint8_t max7219_set_cascade(max7219_handle_t *handle, max7219_cascade_t *cascade, uint16_t len)
{
    uint8_t res;
    uint16_t i;
    
    if (handle == NULL)                                                                 /* check handle */
    {
        return 2;                                                                       /* return error */
    }
    if (handle->inited != 1)                                                            /* check handle initialization */
    {
        return 3;                                                                       /* return error */
    }
    
    if (len > MAX7219_MAX_CASCADE_SIZE)                                                 /* check length */
    {
        handle->debug_print("max7219: len is over MAX7219_MAX_CASCADE_SIZE.\n");        /* write failed */
       
        return 3;                                                                       /* return error */
    }
    
    for (i = 0; i < len; i++)                                                           /* set buf */
    {
        handle->buf[i * 2 + 0] = cascade[i].command;                                    /* set command */
        handle->buf[i * 2 + 1] = cascade[i].data;                                       /* set data */
    }
    res = handle->spi_write_cmd(handle->buf, len * 2);                                  /* write command */
    if (res != 0)                                                                       /* check result */
    {
        handle->debug_print("max7219: write command failed.\n");                        /* write failed */
       
        return 1;                                                                       /* return error */
    }
    
    return 0;                                                                           /* success return 0 */
}

uint8_t max7219_set_decode(max7219_handle_t *handle, max7219_decode_t decode)
{
    uint8_t res;
    uint8_t d;
    
    if (handle == NULL)                                                   /* check handle */
    {
        return 2;                                                         /* return error */
    }
    if (handle->inited != 1)                                              /* check handle initialization */
    {
        return 3;                                                         /* return error */
    }
    
    d = (uint8_t)decode;                                                  /* set the decode */
    res = handle->spi_write(MAX7219_REG_DECODE, (uint8_t *)&d, 1);        /* spi write data */
    if (res != 0)                                                         /* check result */
    {
        handle->debug_print("max7219: set decode failed.\n");             /* write failed */
       
        return 1;                                                         /* return error */
    }
    
    return 0;                                                             /* success return 0 */
}

uint8_t max7219_set_mode(max7219_handle_t *handle, max7219_mode_t mode)
{
    uint8_t res;
    uint8_t m;
    
    if (handle == NULL)                                                      /* check handle */
    {
        return 2;                                                            /* return error */
    }
    if (handle->inited != 1)                                                 /* check handle initialization */
    {
        return 3;                                                            /* return error */
    }
    
    m = (uint8_t)mode;                                                       /* set the mode */
    res = handle->spi_write(MAX7219_REG_SHUT_DOWN, (uint8_t *)&m, 1);        /* spi write data */
    if (res != 0)                                                            /* check result */
    {
        handle->debug_print("max7219: set mode failed.\n");                  /* write failed */
       
        return 1;                                                            /* return error */
    }
    
    return 0;                                                                /* success return 0 */
}

uint8_t max7219_set_display_test_mode(max7219_handle_t *handle, max7219_display_test_mode_t mode)
{
    uint8_t res;
    uint8_t m;
    
    if (handle == NULL)                                                         /* check handle */
    {
        return 2;                                                               /* return error */
    }
    if (handle->inited != 1)                                                    /* check handle initialization */
    {
        return 3;                                                               /* return error */
    }
    
    m = (uint8_t)mode;                                                          /* set the mode */
    res = handle->spi_write(MAX7219_REG_DISPLAY_TEST, (uint8_t *)&m, 1);        /* spi write data */
    if (res != 0)                                                               /* check result */
    {
        handle->debug_print("max7219: set mode failed.\n");                     /* write failed */
       
        return 1;                                                               /* return error */
    }
    
    return 0;                                                                   /* success return 0 */
}

uint8_t max7219_set_intensity(max7219_handle_t *handle, max7219_intensity_t intensity)
{
    uint8_t res;
    uint8_t in;
    
    if (handle == NULL)                                                       /* check handle */
    {
        return 2;                                                             /* return error */
    }
    if (handle->inited != 1)                                                  /* check handle initialization */
    {
        return 3;                                                             /* return error */
    }
    
    in = (uint8_t)intensity;                                                  /* set the intensity */
    res = handle->spi_write(MAX7219_REG_INTENSITY, (uint8_t *)&in, 1);        /* spi write data */
    if (res != 0)                                                             /* check result */
    {
        handle->debug_print("max7219: set intensity failed.\n");              /* write failed */
       
        return 1;                                                             /* return error */
    }
    
    return 0;                                                                 /* success return 0 */
}

uint8_t max7219_set_scan_limit(max7219_handle_t *handle, max7219_scan_limit_t limit)
{
    uint8_t res;
    uint8_t l;
    
    if (handle == NULL)                                                       /* check handle */
    {
        return 2;                                                             /* return error */
    }
    if (handle->inited != 1)                                                  /* check handle initialization */
    {
        return 3;                                                             /* return error */
    }
    
    l = (uint8_t)limit;                                                       /* set the limit */
    res = handle->spi_write(MAX7219_REG_SCAN_LIMIT, (uint8_t *)&l, 1);        /* spi write data */
    if (res != 0)                                                             /* check result */
    {
        handle->debug_print("max7219: set scan limit failed.\n");             /* write failed */
       
        return 1;                                                             /* return error */
    }
    
    return 0;                                                                 /* success return 0 */
}

uint8_t max7219_init(max7219_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->spi_init == NULL)                                        /* check spi_init */
    {
        handle->debug_print("max7219: spi_init is null.\n");             /* spi_init is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->spi_deinit == NULL)                                      /* check spi_deinit */
    {
        handle->debug_print("max7219: spi_deinit is null.\n");           /* spi_deinit is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->spi_write_cmd == NULL)                                   /* check spi_write_cmd */
    {
        handle->debug_print("max7219: spi_write_cmd is null.\n");        /* spi_write_cmd is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->spi_write == NULL)                                       /* check spi_write */
    {
        handle->debug_print("max7219: spi_write is null.\n");            /* spi_write is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->delay_ms == NULL)                                        /* check delay_ms */
    {
        handle->debug_print("max7219: delay_ms is null.\n");             /* delay_ms is null */
       
        return 3;                                                        /* return error */
    }
    
    if (handle->spi_init() != 0)                                         /* spi init */
    {
        handle->debug_print("max7219: spi init failed.\n");              /* spi init failed */
       
        return 1;                                                        /* return error */
    }
    handle->inited = 1;                                                  /* flag finish initialization */
    
    return 0;                                                            /* success return 0 */
}

uint8_t max7219_deinit(max7219_handle_t *handle)
{
    uint8_t res;
    uint8_t mode = (uint8_t)MAX7219_MODE_SHUT_DOWN;
    
    if (handle == NULL)                                                         /* check handle */
    {
        return 2;                                                               /* return error */
    }
    if (handle->inited != 1)                                                    /* check handle initialization */
    {
        return 3;                                                               /* return error */
    }
    
    res = handle->spi_write(MAX7219_REG_SHUT_DOWN, (uint8_t *)&mode, 1);        /* spi write data */
    if (res != 0)                                                               /* check result */
    {
        handle->debug_print("max7219: set mode failed.\n");                     /* write failed */
       
        return 4;                                                               /* return error */
    }
    res = handle->spi_deinit();                                                 /* spi deinit */
    if (res != 0)                                                               /* check result */
    {
        handle->debug_print("max7219: spi deinit failed.\n");                   /* spi deinit failed */
       
        return 1;                                                               /* return error */
    }
    handle->inited = 0;                                                         /* flag close */
    
    return 0;                                                                   /* success return 0 */
}

uint8_t max7219_set_reg(max7219_handle_t *handle, uint8_t reg, 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->spi_write(reg, buf, len) != 0)        /* write data */
    {
        return 1;                                     /* return error */
    }
    else
    {
        return 0;                                     /* success return 0 */
    }
}

uint8_t max7219_info(max7219_info_t *info)
{
    if (info == NULL)                                               /* check handle */
    {
        return 2;                                                   /* return error */
    }
    
    memset(info, 0, sizeof(max7219_info_t));                        /* initialize max7219 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, "SPI", 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 */
}