ctrl_access.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * \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-2018 Microchip Technology Inc. and its subsidiaries.
 *
 * \asf_license_start
 *
 * \page License
 *
 * Subject to your compliance with these terms, you may use Microchip
 * software and any derivatives exclusively with Microchip products.
 * It is your responsibility to comply with third party license terms applicable
 * to your use of third party software (including open source software) that
 * may accompany Microchip software.
 *
 * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES,
 * WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE,
 * INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY,
 * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE
 * LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL
 * LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE
 * SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE
 * POSSIBILITY OR THE DAMAGES ARE FORESEEABLE.  TO THE FULLEST EXTENT
 * ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY
 * RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
 * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
 *
 * \asf_license_stop
 *
 ******************************************************************************/
/*
 * Support and FAQ: visit <a href="https://www.microchip.com/support/">Microchip Support</a>
 */


#ifndef _CTRL_ACCESS_H_
#define _CTRL_ACCESS_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "compiler.h"
#include "conf_access.h"

#ifndef SECTOR_SIZE
#define SECTOR_SIZE  512
#endif

typedef enum
{
  CTRL_GOOD       = PASS,     
  CTRL_FAIL       = FAIL,     
  CTRL_NO_PRESENT = FAIL + 1, 
  CTRL_BUSY       = FAIL + 2  
} 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

#define LUN_ID_0        (0)                 
#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)  
#define LUN_ID_USB      (MAX_LUN)           


// 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

extern bool g_wr_protect;

#endif



#ifdef FREERTOS_USED

extern bool ctrl_access_init(void);

#endif  // FREERTOS_USED

extern U8 get_nb_lun(void);

extern U8 get_cur_lun(void);

extern Ctrl_status mem_test_unit_ready(U8 lun);

extern Ctrl_status mem_read_capacity(U8 lun, U32 *u32_nb_sector);

extern U8 mem_sector_size(U8 lun);

extern bool mem_unload(U8 lun, bool unload);

extern bool mem_wr_protect(U8 lun);

extern bool mem_removal(U8 lun);

extern const char *mem_name(U8 lun);



#if ACCESS_USB == true


extern Ctrl_status memory_2_usb(U8 lun, U32 addr, U16 nb_sector);

extern Ctrl_status usb_2_memory(U8 lun, U32 addr, U16 nb_sector);


#endif  // ACCESS_USB == true


#if ACCESS_MEM_TO_RAM == true


extern Ctrl_status memory_2_ram(U8 lun, U32 addr, void *ram);

extern Ctrl_status ram_2_memory(U8 lun, U32 addr, const void *ram);


#endif  // ACCESS_MEM_TO_RAM == true


#if ACCESS_STREAM == true


#define ID_STREAM_ERR         0xFF

  #if ACCESS_MEM_TO_MEM == true

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

extern Ctrl_status stream_state(U8 id);

extern U16 stream_stop(U8 id);


#endif  // ACCESS_STREAM == true

#ifdef __cplusplus
}
#endif

#endif  // _CTRL_ACCESS_H_