SCSI.h 5.42 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  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 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Header file for SCSI.c.
 */
 
#ifndef _SCSI_H_
#define _SCSI_H_

	/* Includes: */
		#include <avr/io.h>
		#include <avr/pgmspace.h>

43
44
45
		#include <LUFA/Common/Common.h>
		#include <LUFA/Drivers/USB/USB.h>
		#include <LUFA/Drivers/Board/LEDs.h>
46
47
48
49
50
51
52
53
54
55
56

		#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
		 *  the last command failure) in a quick and easy manner.
		 *
57
58
59
		 *  \param[in] key    New SCSI sense key to set the sense code to
		 *  \param[in] acode  New SCSI additional sense key to set the additional sense code to
		 *  \param[in] aqual  New SCSI additional sense key qualifier to set the additional sense qualifier code to
60
		 */
61
62
63
		#define SCSI_SET_SENSE(key, acode, aqual)  MACROS{ SenseData.SenseKey = (key);              \
		                                                   SenseData.AdditionalSenseCode = (acode); \
		                                                   SenseData.AdditionalSenseQualifier = (aqual); }MACROE
64
65

		/** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */
66
		#define DATA_READ           true
67
68

		/** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */
69
		#define DATA_WRITE          false
70
71

		/** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
72
		#define DEVICE_TYPE_BLOCK   0x00
73
		
74
		/** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a CD-ROM device. */
75
		#define DEVICE_TYPE_CDROM   0x05
76

77
78
79
80
81
82
	/* Type Defines: */
		/** Type define for a SCSI response structure to a SCSI INQUIRY command. For details of the
		 *  structure contents, refer to the SCSI specifications.
		 */
		typedef struct
		{
83
84
			unsigned char DeviceType          : 5;
			unsigned char PeripheralQualifier : 3;
85
			
86
87
			unsigned char _RESERVED1          : 7;
			unsigned char Removable           : 1;
88
			
89
			uint8_t       Version;
90
			
91
92
93
94
95
			unsigned char ResponseDataFormat  : 4;
			unsigned char _RESERVED2          : 1;
			unsigned char NormACA             : 1;
			unsigned char TrmTsk              : 1;
			unsigned char AERC                : 1;
96

97
98
			uint8_t       AdditionalLength;
			uint8_t       _RESERVED3[2];
99

100
101
102
103
104
105
106
107
			unsigned char SoftReset           : 1;
			unsigned char CmdQue              : 1;
			unsigned char _RESERVED4          : 1;
			unsigned char Linked              : 1;
			unsigned char Sync                : 1;
			unsigned char WideBus16Bit        : 1;
			unsigned char WideBus32Bit        : 1;
			unsigned char RelAddr             : 1;
108
			
109
110
111
			uint8_t       VendorID[8];
			uint8_t       ProductID[16];
			uint8_t       RevisionID[4];
112
113
114
115
116
117
118
		} 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
		{
119
			uint8_t       ResponseCode;
120
			
121
			uint8_t       SegmentNumber;
122
			
123
124
125
126
127
			unsigned char SenseKey            : 4;
			unsigned char _RESERVED1          : 1;
			unsigned char ILI                 : 1;
			unsigned char EOM                 : 1;
			unsigned char FileMark            : 1;
128
			
129
130
131
132
133
134
135
			uint8_t       Information[4];
			uint8_t       AdditionalLength;
			uint8_t       CmdSpecificInformation[4];
			uint8_t       AdditionalSenseCode;
			uint8_t       AdditionalSenseQualifier;
			uint8_t       FieldReplaceableUnitCode;
			uint8_t       SenseKeySpecific[3];
136
137
138
		} SCSI_Request_Sense_Response_t;
		
	/* Function Prototypes: */
139
		bool SCSI_DecodeSCSICommand(void);
140
141
		
		#if defined(INCLUDE_FROM_SCSI_C)
142
143
144
145
146
			static void SCSI_Command_Inquiry(void);
			static void SCSI_Command_Request_Sense(void);
			static void SCSI_Command_Read_Capacity_10(void);
			static void SCSI_Command_Send_Diagnostic(void);
			static void SCSI_Command_ReadWrite_10(const bool IsDataRead);
147
148
149
		#endif
		
#endif