cascoda_flash.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2016, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef UTILS_FLASH_H
#define UTILS_FLASH_H
 
#include <stdint.h>
#include "ca821x_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct ca_flash_info
{
    uint32_t apromFlashBaseAddr;            
    uint32_t dataFlashBaseAddr;             
    uint32_t manufacturerDataFlashBaseAddr; 
    uint16_t pageSize;                      
    uint8_t  numPages;                      
};
 
ca_error utilsFlashInit(struct ca821x_dev *aInstance, const char *aApplicationName, uint32_t aNodeId);
 
ca_error utilsFlashDeinit(struct ca821x_dev *aInstance);
 
uint32_t utilsFlashGetSize(struct ca821x_dev *aInstance);
 
ca_error utilsFlashErasePage(struct ca821x_dev *aInstance, uint32_t aAddress);
 
ca_error utilsFlashStatusWait(struct ca821x_dev *aInstance, uint32_t aTimeout);
 
uint32_t utilsFlashWrite(struct ca821x_dev *aInstance, uint32_t aAddress, const uint8_t *aData, uint32_t aSize);
 
uint32_t utilsFlashRead(struct ca821x_dev *aInstance, uint32_t aAddress, uint8_t *aData, uint32_t aSize);
 
uint32_t utilsFlashGetBaseAddress(struct ca821x_dev *aInstance);
 
uint32_t utilsFlashGetUsedSize(struct ca821x_dev *aInstance);
 
void utilsFlashSetBaseAddress(struct ca821x_dev *aInstance, uint32_t aAddress);
 
void utilsFlashSetUsedSize(struct ca821x_dev *aInstance, uint32_t aSize);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // UTILS_FLASH_H