blob: 9949d89f963eea957506a777240949948422f753 [file] [log] [blame]
/*This file is prepared for Doxygen automatic documentation generation.*/
/*! \file ******************************************************************
*
* \brief Management of the virtual memory.
*
* This file manages the virtual memory.
*
* - Compiler: IAR EWAVR32 and GNU GCC for AVR32
* - Supported devices: All AVR32 devices with a USB 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 _MEDIA_MEM_H_
#define _MEDIA_MEM_H_
#include "board.h"
#include "memories.h"
#include "conf_access.h"
#if (MEDIA_0_MEM == ENABLE) || (MEDIA_1_MEM == ENABLE) || (MEDIA_2_MEM == ENABLE)
#include "ctrl_access.h"
#ifdef __cplusplus
extern "C" {
#endif
//_____ D E F I N I T I O N S ______________________________________________
/*! \name Media Status
*
* Status List for the Storage Media
*
*/
//! @{
#define MEDIA_REMOVED 0
#define MEDIA_INSERTED 1
#define MEDIA_REMOVING 2
//! @}
#define MEDIA_SECTOR_SIZE 512
extern Media medias[];
extern uint32_t numMedias;
//---- CONTROL FUNCTIONS ----
extern Ctrl_status media_test_unit_ready (U8 media);
extern Ctrl_status media_test_unit_ready_0(void);
extern Ctrl_status media_test_unit_ready_1(void);
extern Ctrl_status media_test_unit_ready_2(void);
extern Ctrl_status media_read_capacity (U8 media, U32 *u32_nb_sector);
extern Ctrl_status media_read_capacity_0(U32 *u32_nb_sector);
extern Ctrl_status media_read_capacity_1(U32 *u32_nb_sector);
extern Ctrl_status media_read_capacity_2(U32 *u32_nb_sector);
extern Bool media_wr_protect (U8 media);
extern Bool media_wr_protect_0(void);
extern Bool media_wr_protect_1(void);
extern Bool media_wr_protect_2(void);
extern Bool media_removal (U8 media);
extern Bool media_removal_0(void);
extern Bool media_removal_1(void);
extern Bool media_removal_2(void);
//---- ACCESS DATA Setting FUNCTIONS ----
extern void media_access_init_default(void);
extern void media_access_init_customize(void* pBuffer, U16 wNbParts, U32 dwPartSiz);
//---- ACCESS DATA FUNCTIONS ----
// USB interface
#if ACCESS_USB == ENABLED
extern Ctrl_status media_usb_read_10 (U8 media, U32 addr, U16 nb_sector);
extern Ctrl_status media_usb_read_10_0 ( U32 addr, U16 nb_sector);
extern Ctrl_status media_usb_read_10_1 ( U32 addr, U16 nb_sector);
extern Ctrl_status media_usb_read_10_2 ( U32 addr, U16 nb_sector);
extern Ctrl_status media_usb_write_10 (U8 media, U32 addr, U16 nb_sector);
extern Ctrl_status media_usb_write_10_0( U32 addr, U16 nb_sector);
extern Ctrl_status media_usb_write_10_1( U32 addr, U16 nb_sector);
extern Ctrl_status media_usb_write_10_2( U32 addr, U16 nb_sector);
#endif
// RAM interface
#if ACCESS_MEM_TO_RAM == ENABLED
extern Ctrl_status media_mem_2_ram (U8 media, U32 addr, void *ram);
extern Ctrl_status media_mem_2_ram_0( U32 addr, void *ram);
extern Ctrl_status media_mem_2_ram_1( U32 addr, void *ram);
extern Ctrl_status media_mem_2_ram_2( U32 addr, void *ram);
extern Ctrl_status media_ram_2_mem (U8 media, U32 addr, const void *ram);
extern Ctrl_status media_ram_2_mem_0( U32 addr, const void *ram);
extern Ctrl_status media_ram_2_mem_1( U32 addr, const void *ram);
extern Ctrl_status media_ram_2_mem_2( U32 addr, const void *ram);
#endif
#ifdef __cplusplus
}
#endif
#endif
#endif // _MEDIA_MEM_H_