lib/lufa/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for MassStoreCommands.c.
  34  */
  35
  36 #ifndef _MASS_STORE_COMMANDS_H_
  37 #define _MASS_STORE_COMMANDS_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41
  42                 #include "../MassStorageHost.h"
  43
  44                 #include <LUFA/Drivers/USB/USB.h>
  45
  46         /* Macros: */
  47                 /** Timeout period between the issuing of a CBW to a device, and the reception of the first packet. */
  48                 #define COMMAND_DATA_TIMEOUT_MS             10000
  49
  50                 /** Additional error code for Mass Storage functions when a device returns a logical command failure. */
  51                 #define MASS_STORE_SCSI_COMMAND_FAILED      0xC0
  52
  53         /* Function Prototypes: */
  54                 #if defined(INCLUDE_FROM_MASSSTORE_COMMANDS_C)
  55                         static uint8_t MassStore_SendCommand(MS_CommandBlockWrapper_t* const SCSICommandBlock,
  56                                                              void* BufferPtr);
  57                         static uint8_t MassStore_WaitForDataReceived(void);
  58                         static uint8_t MassStore_SendReceiveData(MS_CommandBlockWrapper_t* const SCSICommandBlock,
  59                                                                  void* BufferPtr) ATTR_NON_NULL_PTR_ARG(1);
  60                         static uint8_t MassStore_GetReturnedStatus(MS_CommandStatusWrapper_t* const SCSICommandStatus) ATTR_NON_NULL_PTR_ARG(1);
  61                 #endif
  62
  63                 uint8_t MassStore_MassStorageReset(void);
  64                 uint8_t MassStore_GetMaxLUN(uint8_t* const MaxLUNIndex);
  65                 uint8_t MassStore_RequestSense(const uint8_t LUNIndex,
  66                                                SCSI_Request_Sense_Response_t* const SensePtr) ATTR_NON_NULL_PTR_ARG(2);
  67                 uint8_t MassStore_Inquiry(const uint8_t LUNIndex,
  68                                           SCSI_Inquiry_Response_t* const InquiryPtr) ATTR_NON_NULL_PTR_ARG(2);
  69                 uint8_t MassStore_ReadDeviceBlock(const uint8_t LUNIndex,
  70                                                   const uint32_t BlockAddress,
  71                                                   const uint8_t Blocks,
  72                                                   const uint16_t BlockSize,
  73                                                   void* BufferPtr) ATTR_NON_NULL_PTR_ARG(5);
  74                 uint8_t MassStore_WriteDeviceBlock(const uint8_t LUNIndex,
  75                                                    const uint32_t BlockAddress,
  76                                            const uint8_t Blocks,
  77                                                    const uint16_t BlockSize,
  78                                                    void* BufferPtr) ATTR_NON_NULL_PTR_ARG(5);
  79                 uint8_t MassStore_ReadCapacity(const uint8_t LUNIndex,
  80                                                SCSI_Capacity_t* const CapacityPtr) ATTR_NON_NULL_PTR_ARG(2);
  81                 uint8_t MassStore_TestUnitReady(const uint8_t LUNIndex);
  82                 uint8_t MassStore_PreventAllowMediumRemoval(const uint8_t LUNIndex,
  83                                                             const bool PreventRemoval);
  84
  85 #endif
  86