123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402 |
- /*****************************************************************************
- *
- * \file
- *
- * \brief Abstraction layer for memory interfaces.
- *
- * This module contains the interfaces:
- * - MEM <-> USB;
- * - MEM <-> RAM;
- * - MEM <-> MEM.
- *
- * This module may be configured and expanded to support the following features:
- * - write-protected globals;
- * - password-protected data;
- * - specific features;
- * - etc.
- *
- * Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.
- *
- * \asf_license_start
- *
- * \page License
- *
- * 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 microcontroller 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.
- *
- * \asf_license_stop
- *
- ******************************************************************************/
- /*
- * Support and FAQ: visit <a href="https://www.atmel.com/design-support/">Atmel Support</a>
- */
-
-
- #ifndef _CTRL_ACCESS_H_
- #define _CTRL_ACCESS_H_
-
- #ifdef __cplusplus
- extern "C" {
- #endif
-
- /**
- * \defgroup group_common_services_storage_ctrl_access Memory Control Access
- *
- * Common abstraction layer for memory interfaces. It provides interfaces between:
- * Memory and USB, Memory and RAM, Memory and Memory. Common API for XMEGA and UC3.
- *
- * \{
- */
-
- #include "compiler.h"
- #include "conf_access.h"
-
- #ifndef SECTOR_SIZE
- #define SECTOR_SIZE 512
- #endif
-
- //! Status returned by CTRL_ACCESS interfaces.
- typedef enum
- {
- CTRL_GOOD = PASS, //!< Success, memory ready.
- CTRL_FAIL = FAIL, //!< An error occurred.
- CTRL_NO_PRESENT = FAIL + 1, //!< Memory unplugged.
- CTRL_BUSY = FAIL + 2 //!< Memory not initialized or changed.
- } Ctrl_status;
-
-
- // FYI: Each Logical Unit Number (LUN) corresponds to a memory.
-
- // Check LUN defines.
- #ifndef LUN_0
- #error LUN_0 must be defined as ENABLE or DISABLE in conf_access.h
- #endif
- #ifndef LUN_1
- #error LUN_1 must be defined as ENABLE or DISABLE in conf_access.h
- #endif
- #ifndef LUN_2
- #error LUN_2 must be defined as ENABLE or DISABLE in conf_access.h
- #endif
- #ifndef LUN_3
- #error LUN_3 must be defined as ENABLE or DISABLE in conf_access.h
- #endif
- #ifndef LUN_4
- #error LUN_4 must be defined as ENABLE or DISABLE in conf_access.h
- #endif
- #ifndef LUN_5
- #error LUN_5 must be defined as ENABLE or DISABLE in conf_access.h
- #endif
- #ifndef LUN_6
- #error LUN_6 must be defined as ENABLE or DISABLE in conf_access.h
- #endif
- #ifndef LUN_7
- #error LUN_7 must be defined as ENABLE or DISABLE in conf_access.h
- #endif
- #ifndef LUN_USB
- #error LUN_USB must be defined as ENABLE or DISABLE in conf_access.h
- #endif
-
- /*! \name LUN IDs
- */
- //! @{
- #define LUN_ID_0 (0) //!< First static LUN.
- #define LUN_ID_1 (LUN_ID_0 + LUN_0)
- #define LUN_ID_2 (LUN_ID_1 + LUN_1)
- #define LUN_ID_3 (LUN_ID_2 + LUN_2)
- #define LUN_ID_4 (LUN_ID_3 + LUN_3)
- #define LUN_ID_5 (LUN_ID_4 + LUN_4)
- #define LUN_ID_6 (LUN_ID_5 + LUN_5)
- #define LUN_ID_7 (LUN_ID_6 + LUN_6)
- #define MAX_LUN (LUN_ID_7 + LUN_7) //!< Number of static LUNs.
- #define LUN_ID_USB (MAX_LUN) //!< First dynamic LUN (USB host mass storage).
- //! @}
-
-
- // Include LUN header files.
- #if LUN_0 == ENABLE
- #include LUN_0_INCLUDE
- #endif
- #if LUN_1 == ENABLE
- #include LUN_1_INCLUDE
- #endif
- #if LUN_2 == ENABLE
- #include LUN_2_INCLUDE
- #endif
- #if LUN_3 == ENABLE
- #include LUN_3_INCLUDE
- #endif
- #if LUN_4 == ENABLE
- #include LUN_4_INCLUDE
- #endif
- #if LUN_5 == ENABLE
- #include LUN_5_INCLUDE
- #endif
- #if LUN_6 == ENABLE
- #include LUN_6_INCLUDE
- #endif
- #if LUN_7 == ENABLE
- #include LUN_7_INCLUDE
- #endif
- #if LUN_USB == ENABLE
- #include LUN_USB_INCLUDE
- #endif
-
-
- // Check the configuration of write protection in conf_access.h.
- #ifndef GLOBAL_WR_PROTECT
- #error GLOBAL_WR_PROTECT must be defined as true or false in conf_access.h
- #endif
-
-
- #if GLOBAL_WR_PROTECT == true
-
- //! Write protect.
- extern bool g_wr_protect;
-
- #endif
-
-
- /*! \name Control Interface
- */
- //! @{
-
- #ifdef FREERTOS_USED
-
- /*! \brief Initializes the LUN access locker.
- *
- * \return \c true if the locker was successfully initialized, else \c false.
- */
- extern bool ctrl_access_init(void);
-
- #endif // FREERTOS_USED
-
- /*! \brief Returns the number of LUNs.
- *
- * \return Number of LUNs in the system.
- */
- extern U8 get_nb_lun(void);
-
- /*! \brief Returns the current LUN.
- *
- * \return Current LUN.
- *
- * \todo Implement.
- */
- extern U8 get_cur_lun(void);
-
- /*! \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.
- *
- * \param lun Logical Unit Number.
- *
- * \return Status.
- */
- extern Ctrl_status mem_test_unit_ready(U8 lun);
-
- /*! \brief Returns the address of the last valid sector (512 bytes) in the
- * memory.
- *
- * \param lun Logical Unit Number.
- * \param u32_nb_sector Pointer to the address of the last valid sector.
- *
- * \return Status.
- */
- extern Ctrl_status mem_read_capacity(U8 lun, U32 *u32_nb_sector);
-
- /*! \brief Returns the size of the physical sector.
- *
- * \param lun Logical Unit Number.
- *
- * \return Sector size (unit: 512 bytes).
- */
- extern U8 mem_sector_size(U8 lun);
-
- /*! \brief Unload/load the medium.
- *
- * \param lun Logical Unit Number.
- * \param unload \c true to unload the medium, \c false to load the medium.
- *
- * \return \c true if unload/load success, else \c false.
- */
- extern bool mem_unload(U8 lun, bool unload);
-
- /*! \brief Returns the write-protection state of the memory.
- *
- * \param lun Logical Unit Number.
- *
- * \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 mem_wr_protect(U8 lun);
-
- /*! \brief Tells whether the memory is removable.
- *
- * \param lun Logical Unit Number.
- *
- * \return \c true if the memory is removable, else \c false.
- */
- extern bool mem_removal(U8 lun);
-
- /*! \brief Returns a pointer to the LUN name.
- *
- * \param lun Logical Unit Number.
- *
- * \return Pointer to the LUN name string.
- */
- extern const char *mem_name(U8 lun);
-
- //! @}
-
-
- #if ACCESS_USB == true
-
- /*! \name MEM <-> USB Interface
- */
- //! @{
-
- /*! \brief Transfers data from the memory to USB.
- *
- * \param lun Logical Unit Number.
- * \param addr Address of first memory sector to read.
- * \param nb_sector Number of sectors to transfer.
- *
- * \return Status.
- */
- extern Ctrl_status memory_2_usb(U8 lun, U32 addr, U16 nb_sector);
-
- /*! \brief Transfers data from USB to the memory.
- *
- * \param lun Logical Unit Number.
- * \param addr Address of first memory sector to write.
- * \param nb_sector Number of sectors to transfer.
- *
- * \return Status.
- */
- extern Ctrl_status usb_2_memory(U8 lun, U32 addr, U16 nb_sector);
-
- //! @}
-
- #endif // ACCESS_USB == true
-
-
- #if ACCESS_MEM_TO_RAM == true
-
- /*! \name MEM <-> RAM Interface
- */
- //! @{
-
- /*! \brief Copies 1 data sector from the memory to RAM.
- *
- * \param lun Logical Unit Number.
- * \param addr Address of first memory sector to read.
- * \param ram Pointer to RAM buffer to write.
- *
- * \return Status.
- */
- extern Ctrl_status memory_2_ram(U8 lun, U32 addr, void *ram);
-
- /*! \brief Copies 1 data sector from RAM to the memory.
- *
- * \param lun Logical Unit Number.
- * \param addr Address of first memory sector to write.
- * \param ram Pointer to RAM buffer to read.
- *
- * \return Status.
- */
- extern Ctrl_status ram_2_memory(U8 lun, U32 addr, const void *ram);
-
- //! @}
-
- #endif // ACCESS_MEM_TO_RAM == true
-
-
- #if ACCESS_STREAM == true
-
- /*! \name Streaming MEM <-> MEM Interface
- */
- //! @{
-
- //! Erroneous streaming data transfer ID.
- #define ID_STREAM_ERR 0xFF
-
- #if ACCESS_MEM_TO_MEM == true
-
- /*! \brief Copies data from one memory to another.
- *
- * \param src_lun Source Logical Unit Number.
- * \param src_addr Source address of first memory sector to read.
- * \param dest_lun Destination Logical Unit Number.
- * \param dest_addr Destination address of first memory sector to write.
- * \param nb_sector Number of sectors to copy.
- *
- * \return Status.
- */
- extern Ctrl_status stream_mem_to_mem(U8 src_lun, U32 src_addr, U8 dest_lun, U32 dest_addr, U16 nb_sector);
-
- #endif // ACCESS_MEM_TO_MEM == true
-
- /*! \brief Returns the state of a streaming data transfer.
- *
- * \param id Transfer ID.
- *
- * \return Status.
- *
- * \todo Implement.
- */
- extern Ctrl_status stream_state(U8 id);
-
- /*! \brief Stops a streaming data transfer.
- *
- * \param id Transfer ID.
- *
- * \return Number of remaining sectors.
- *
- * \todo Implement.
- */
- extern U16 stream_stop(U8 id);
-
- //! @}
-
- #endif // ACCESS_STREAM == true
-
- /**
- * \}
- */
-
- #ifdef __cplusplus
- }
- #endif
-
- #endif // _CTRL_ACCESS_H_
|