Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / Demos / Device / LowLevel / MassStorage / Lib / SCSI.h

diff --git a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h
index 0fc99b6..8710db8 100644 (file)
--- a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h
+++ b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -32,7 +32,7 @@
  *
  *  Header file for SCSI.c.
  */
  *
  *  Header file for SCSI.c.
  */

- 
+

 #ifndef _SCSI_H_
 #define _SCSI_H_
 
 #ifndef _SCSI_H_
 #define _SCSI_H_
 


@@ -47,8 +47,7 @@
                #include "MassStorage.h"
                #include "Descriptors.h"
                #include "DataflashManager.h"
                #include "MassStorage.h"
                #include "Descriptors.h"
                #include "DataflashManager.h"

-               #include "SCSI_Codes.h"
-       
+

        /* Macros: */
                /** Macro to set the current SCSI sense data to the given key, additional sense code and additional sense qualifier. This
                 *  is for convenience, as it allows for all three sense values (returned upon request to the host to give information about
        /* Macros: */
                /** Macro to set the current SCSI sense data to the given key, additional sense code and additional sense qualifier. This
                 *  is for convenience, as it allows for all three sense values (returned upon request to the host to give information about


@@ -70,7 +69,7 @@
 
                /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
                #define DEVICE_TYPE_BLOCK   0x00
 
                /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
                #define DEVICE_TYPE_BLOCK   0x00

-               
+

                /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a CD-ROM device. */
                #define DEVICE_TYPE_CDROM   0x05
 
                /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a CD-ROM device. */
                #define DEVICE_TYPE_CDROM   0x05
 


@@ -82,12 +81,12 @@
                {
                        unsigned char DeviceType          : 5;
                        unsigned char PeripheralQualifier : 3;
                {
                        unsigned char DeviceType          : 5;
                        unsigned char PeripheralQualifier : 3;

-                       
+

                        unsigned char Reserved            : 7;
                        unsigned char Removable           : 1;
                        unsigned char Reserved            : 7;
                        unsigned char Removable           : 1;

-                       
+

                        uint8_t       Version;
                        uint8_t       Version;

-                       
+

                        unsigned char ResponseDataFormat  : 4;
                        unsigned char Reserved2           : 1;
                        unsigned char NormACA             : 1;
                        unsigned char ResponseDataFormat  : 4;
                        unsigned char Reserved2           : 1;
                        unsigned char NormACA             : 1;


@@ -105,27 +104,27 @@
                        unsigned char WideBus16Bit        : 1;
                        unsigned char WideBus32Bit        : 1;
                        unsigned char RelAddr             : 1;
                        unsigned char WideBus16Bit        : 1;
                        unsigned char WideBus32Bit        : 1;
                        unsigned char RelAddr             : 1;

-                       
+

                        uint8_t       VendorID[8];
                        uint8_t       ProductID[16];
                        uint8_t       RevisionID[4];
                        uint8_t       VendorID[8];
                        uint8_t       ProductID[16];
                        uint8_t       RevisionID[4];

-               } SCSI_Inquiry_Response_t;
-               
+               } MS_SCSI_Inquiry_Response_t;
+

                /** Type define for a SCSI sense structure to a SCSI REQUEST SENSE command. For details of the
                 *  structure contents, refer to the SCSI specifications.
                 */
                typedef struct
                {
                        uint8_t       ResponseCode;
                /** Type define for a SCSI sense structure to a SCSI REQUEST SENSE command. For details of the
                 *  structure contents, refer to the SCSI specifications.
                 */
                typedef struct
                {
                        uint8_t       ResponseCode;

-                       
+

                        uint8_t       SegmentNumber;
                        uint8_t       SegmentNumber;

-                       
+

                        unsigned char SenseKey            : 4;
                        unsigned char Reserved            : 1;
                        unsigned char ILI                 : 1;
                        unsigned char EOM                 : 1;
                        unsigned char FileMark            : 1;
                        unsigned char SenseKey            : 4;
                        unsigned char Reserved            : 1;
                        unsigned char ILI                 : 1;
                        unsigned char EOM                 : 1;
                        unsigned char FileMark            : 1;

-                       
+

                        uint8_t       Information[4];
                        uint8_t       AdditionalLength;
                        uint8_t       CmdSpecificInformation[4];
                        uint8_t       Information[4];
                        uint8_t       AdditionalLength;
                        uint8_t       CmdSpecificInformation[4];


@@ -133,17 +132,19 @@
                        uint8_t       AdditionalSenseQualifier;
                        uint8_t       FieldReplaceableUnitCode;
                        uint8_t       SenseKeySpecific[3];
                        uint8_t       AdditionalSenseQualifier;
                        uint8_t       FieldReplaceableUnitCode;
                        uint8_t       SenseKeySpecific[3];

-               } SCSI_Request_Sense_Response_t;
-               
+               } MS_SCSI_Request_Sense_Response_t;
+

        /* Function Prototypes: */
                bool SCSI_DecodeSCSICommand(void);
        /* Function Prototypes: */
                bool SCSI_DecodeSCSICommand(void);

-               
+

                #if defined(INCLUDE_FROM_SCSI_C)
                        static bool SCSI_Command_Inquiry(void);
                        static bool SCSI_Command_Request_Sense(void);
                        static bool SCSI_Command_Read_Capacity_10(void);
                        static bool SCSI_Command_Send_Diagnostic(void);
                        static bool SCSI_Command_ReadWrite_10(const bool IsDataRead);
                #if defined(INCLUDE_FROM_SCSI_C)
                        static bool SCSI_Command_Inquiry(void);
                        static bool SCSI_Command_Request_Sense(void);
                        static bool SCSI_Command_Read_Capacity_10(void);
                        static bool SCSI_Command_Send_Diagnostic(void);
                        static bool SCSI_Command_ReadWrite_10(const bool IsDataRead);

+                       static bool SCSI_Command_ModeSense_6(void);

                #endif
                #endif

-               
+

 #endif
 #endif

+