at24cm0x.h

Go to the documentation of this file.

 
#ifndef AT24CM0X_H_
#define AT24CM0X_H_
    
    #ifndef AT24CM0X_HAL_PLATFORM
        #define AT24CM0X_HAL_PLATFORM avr0
    #endif
 
    #ifndef AT24CM0X_MEMORY_SIZE
        #define AT24CM0X_MEMORY_SIZE 262144UL
    #endif
 
    #ifndef AT24CM0X_PAGES
        #define AT24CM0X_PAGES 1024UL
    #endif
    
    #ifndef AT24CM0X_PAGE_SIZE
        #define AT24CM0X_PAGE_SIZE 256UL
    #endif
    
    #ifndef AT24CM0X_ENABLE_INTEGRITY_CHECK
        //#define AT24CM0X_ENABLE_INTEGRITY_CHECK
 
        #ifdef _DOXYGEN_    // Used for documentation, can be ignored
            #define AT24CM0X_ENABLE_INTEGRITY_CHECK
        #endif
    #endif
    
    #ifndef AT24CM0X_WRITE_ACKNOWLEDGE_POLLING
        //#define AT24CM0X_WRITE_ACKNOWLEDGE_POLLING
 
        #ifdef _DOXYGEN_    // Used for documentation, can be ignored
            #define AT24CM0X_WRITE_ACKNOWLEDGE_POLLING
        #endif
    #endif
    
    #ifndef AT24CM0X_BASE_ADDRESS
        #define AT24CM0X_BASE_ADDRESS 0x50

        #ifndef AT24CM0X_ADDRESS_MASK
            #if AT24CM0X_MEMORY_SIZE < 262144UL
                #define AT24CM0X_ADDRESS_MASK 0x06
            #else
                #define AT24CM0X_ADDRESS_MASK 0x04
            #endif
        #endif

        #ifndef AT24CM0X_ADDRESS_HIGH_MASK
            #if AT24CM0X_MEMORY_SIZE < 262144UL
                #define AT24CM0X_ADDRESS_HIGH_MASK 0x01
            #else
                #define AT24CM0X_ADDRESS_HIGH_MASK 0x03
            #endif
        #endif
    #endif
    
    #ifndef AT24CM0X_MULTI_DEVICES
        //#define AT24CM0X_MULTI_DEVICES
 
        #ifdef _DOXYGEN_    // Used for documentation, can be ignored
            #define AT24CM0X_MULTI_DEVICES
        #endif
    #endif
    
    #ifndef AT24CM0X_MULTI_DEVICES
        #ifndef AT24CM0X_ADDRESS_A2
            #define AT24CM0X_ADDRESS_A2 1
        #endif
 
        #ifndef AT24CM0X_ADDRESS

            #if AT24CM0X_MEMORY_SIZE < 262144UL
                #ifndef AT24CM0X_ADDRESS_A1
                    #define AT24CM0X_ADDRESS_A1 1
                #endif

                #define AT24CM0X_ADDRESS (AT24CM0X_BASE_ADDRESS | (AT24CM0X_ADDRESS_A2<<2) | (AT24CM0X_ADDRESS_A1<<1))
            #else
                #define AT24CM0X_ADDRESS (AT24CM0X_BASE_ADDRESS | (AT24CM0X_ADDRESS_A2<<2))
            #endif
 
        #endif
    #endif
    
    #ifndef AT24CM0X_WP_CONTROL_EN
        //#define AT24CM0X_WP_CONTROL_EN
 
        #ifdef _DOXYGEN_    // Used for documentation, can be ignored
            #define AT24CM0X_WP_CONTROL_EN
        #endif
    #endif
    
    #ifndef AT24CM0X_WRITE_CYCLE_MS
        #define AT24CM0X_WRITE_CYCLE_MS 10UL
    #endif
    
    #include "../../../utils/macros/stringify.h"
 
    #include _STR(../../../hal/AT24CM0X_HAL_PLATFORM/twi/twi.h)
    
    #include "../../../utils/systick/systick.h"
 
    #ifdef AT24CM0X_WP_CONTROL_EN
        enum AT24CM0X_WP_Mode_t
        {
            AT24CM0X_WP_Mode_Enabled = 0,  
            AT24CM0X_WP_Mode_Disabled      
        };

        typedef enum AT24CM0X_WP_Mode_t AT24CM0X_WP_Mode;
    #endif
    
    enum AT24CM0X_Status_t
    {
        AT24CM0X_Status_Done = 0,        
        AT24CM0X_Status_Address_Error,   
        AT24CM0X_Status_Page_Error,      
        AT24CM0X_Status_Size_Error,      
        AT24CM0X_Status_Data_Error,      
        AT24CM0X_Status_TWI_Error,       
        AT24CM0X_Status_General_Error    
    };

    typedef enum AT24CM0X_Status_t AT24CM0X_Status;
    
               void at24cm0x_init(void);
    
    #ifdef AT24CM0X_MULTI_DEVICES
               void at24cm0x_device(unsigned char identifier);
    #endif
    
    #ifdef AT24CM0X_WP_CONTROL_EN
               void at24cm0x_wp(AT24CM0X_WP_Mode mode);
    #endif
    
    AT24CM0X_Status at24cm0x_write_byte(unsigned long address, unsigned char data);
    AT24CM0X_Status at24cm0x_write_page(unsigned int page, unsigned char *data, unsigned int size);
    AT24CM0X_Status at24cm0x_read_current_byte(unsigned char *data);
    AT24CM0X_Status at24cm0x_read_byte(unsigned long address, unsigned char *data);
    AT24CM0X_Status at24cm0x_read_sequential(unsigned long address, unsigned char *data, unsigned int size);
 
#endif /* AT24CM0X_H_ */