165 lines
4.8 KiB
C
Executable file
165 lines
4.8 KiB
C
Executable file
/* This header file is part of the ATMEL AVR-UC3-SoftwareFramework-1.7.0 Release */
|
|
|
|
/*This file is prepared for Doxygen automatic documentation generation.*/
|
|
/*! \file *********************************************************************
|
|
*
|
|
* \brief CTRL_ACCESS interface for the AT45DBX data flash controller.
|
|
*
|
|
* - Compiler: IAR EWAVR32 and GNU GCC for AVR32
|
|
* - Supported devices: All AVR32 devices with an SPI module can be used.
|
|
* - AppNote:
|
|
*
|
|
* \author Atmel Corporation: http://www.atmel.com \n
|
|
* Support and FAQ: http://support.atmel.no/
|
|
*
|
|
******************************************************************************/
|
|
|
|
/* Copyright (c) 2009 Atmel Corporation. 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. The name of Atmel may not be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* 4. This software may only be redistributed and used in connection with an Atmel
|
|
* AVR product.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
|
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL 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 _AT45DBX_MEM_H_
|
|
#define _AT45DBX_MEM_H_
|
|
|
|
|
|
#include "conf_access.h"
|
|
|
|
#if AT45DBX_MEM == DISABLE
|
|
#error at45dbx_mem.h is #included although AT45DBX_MEM is disabled
|
|
#endif
|
|
|
|
|
|
#include "ctrl_access.h"
|
|
|
|
|
|
//_____ D E C L A R A T I O N S ____________________________________________
|
|
|
|
/*! \name Control Interface
|
|
*/
|
|
//! @{
|
|
|
|
/*! \brief Tests the memory state and initializes the memory if required.
|
|
*
|
|
* The TEST UNIT READY SCSI primary command allows an application client to poll
|
|
* a LUN until it is ready without having to allocate memory for returned data.
|
|
*
|
|
* This command may be used to check the media status of LUNs with removable
|
|
* media.
|
|
*
|
|
* \return Status.
|
|
*/
|
|
extern Ctrl_status at45dbx_test_unit_ready(void);
|
|
|
|
/*! \brief Returns the address of the last valid sector in the memory.
|
|
*
|
|
* \param u32_nb_sector Pointer to the address of the last valid sector.
|
|
*
|
|
* \return Status.
|
|
*/
|
|
extern Ctrl_status at45dbx_read_capacity(U32 *u32_nb_sector);
|
|
|
|
/*! \brief Returns the write-protection state of the memory.
|
|
*
|
|
* \return \c TRUE if the memory is write-protected, else \c FALSE.
|
|
*
|
|
* \note Only used by removable memories with hardware-specific write
|
|
* protection.
|
|
*/
|
|
extern Bool at45dbx_wr_protect(void);
|
|
|
|
/*! \brief Tells whether the memory is removable.
|
|
*
|
|
* \return \c TRUE if the memory is removable, else \c FALSE.
|
|
*/
|
|
extern Bool at45dbx_removal(void);
|
|
|
|
//! @}
|
|
|
|
|
|
#if ACCESS_USB == ENABLED
|
|
|
|
/*! \name MEM <-> USB Interface
|
|
*/
|
|
//! @{
|
|
|
|
/*! \brief Tranfers data from the memory to USB.
|
|
*
|
|
* \param addr Address of first memory sector to read.
|
|
* \param nb_sector Number of sectors to transfer.
|
|
*
|
|
* \return Status.
|
|
*/
|
|
extern Ctrl_status at45dbx_usb_read_10(U32 addr, U16 nb_sector);
|
|
|
|
/*! \brief Tranfers data from USB to the memory.
|
|
*
|
|
* \param addr Address of first memory sector to write.
|
|
* \param nb_sector Number of sectors to transfer.
|
|
*
|
|
* \return Status.
|
|
*/
|
|
extern Ctrl_status at45dbx_usb_write_10(U32 addr, U16 nb_sector);
|
|
|
|
//! @}
|
|
|
|
#endif
|
|
|
|
|
|
#if ACCESS_MEM_TO_RAM == ENABLED
|
|
|
|
/*! \name MEM <-> RAM Interface
|
|
*/
|
|
//! @{
|
|
|
|
/*! \brief Copies 1 data sector from the memory to RAM.
|
|
*
|
|
* \param addr Address of first memory sector to read.
|
|
* \param ram Pointer to RAM buffer to write.
|
|
*
|
|
* \return Status.
|
|
*/
|
|
extern Ctrl_status at45dbx_df_2_ram(U32 addr, void *ram);
|
|
|
|
/*! \brief Copies 1 data sector from RAM to the memory.
|
|
*
|
|
* \param addr Address of first memory sector to write.
|
|
* \param ram Pointer to RAM buffer to read.
|
|
*
|
|
* \return Status.
|
|
*/
|
|
extern Ctrl_status at45dbx_ram_2_df(U32 addr, const void *ram);
|
|
|
|
//! @}
|
|
|
|
#endif
|
|
|
|
|
|
#endif // _AT45DBX_MEM_H_
|