Fix bug in using nor flash storage without SD
[SCSI2SD.git] / software / SCSI2SD / src / scsi.h
1 //      Copyright (C) 2013 Michael McMaster <michael@codesrc.com>
2 //
3 //      This file is part of SCSI2SD.
4 //
5 //      SCSI2SD is free software: you can redistribute it and/or modify
6 //      it under the terms of the GNU General Public License as published by
7 //      the Free Software Foundation, either version 3 of the License, or
8 //      (at your option) any later version.
9 //
10 //      SCSI2SD is distributed in the hope that it will be useful,
11 //      but WITHOUT ANY WARRANTY; without even the implied warranty of
12 //      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 //      GNU General Public License for more details.
14 //
15 //      You should have received a copy of the GNU General Public License
16 //      along with SCSI2SD.  If not, see <http://www.gnu.org/licenses/>.
17 #ifndef SCSI_H
18 #define SCSI_H
19
20 #include "storedevice.h"
21 #include "geometry.h"
22
23 typedef enum
24 {
25         // internal bits
26         __scsiphase_msg = 1,
27         __scsiphase_cd = 2,
28         __scsiphase_io = 4,
29
30         BUS_FREE = -1,
31         BUS_BUSY = -2,
32         ARBITRATION = -3,
33         SELECTION = -4,
34         RESELECTION = -5,
35         STATUS = __scsiphase_cd | __scsiphase_io,
36         COMMAND = __scsiphase_cd,
37         DATA_IN = __scsiphase_io,
38         DATA_OUT = 0,
39         MESSAGE_IN = __scsiphase_msg | __scsiphase_cd | __scsiphase_io,
40         MESSAGE_OUT = __scsiphase_msg | __scsiphase_cd
41 } SCSI_PHASE;
42
43 typedef enum
44 {
45         GOOD = 0,
46         CHECK_CONDITION = 2,
47         BUSY = 0x8,
48         INTERMEDIATE = 0x10,
49         CONFLICT = 0x18
50 } SCSI_STATUS;
51
52 typedef enum
53 {
54         MSG_COMMAND_COMPLETE = 0,
55         MSG_REJECT = 0x7,
56         MSG_LINKED_COMMAND_COMPLETE = 0x0A,
57         MSG_LINKED_COMMAND_COMPLETE_WITH_FLAG = 0x0B
58 } SCSI_MESSAGE;
59
60 typedef enum
61 {
62         COMPAT_UNKNOWN,
63         COMPAT_SCSI1,
64
65         // Messages are being used, yet SCSI 2 mode is disabled.
66         // This impacts interpretation of INQUIRY commands.
67         COMPAT_SCSI2_DISABLED,
68
69         COMPAT_SCSI2
70 } SCSI_COMPAT_MODE;
71
72 // Maximum value for bytes-per-sector.
73 #define MAX_SECTOR_SIZE 8192
74 #define MIN_SECTOR_SIZE 64
75
76 typedef struct
77 {
78         S2S_Target* target;
79     S2S_BoardConfig boardCfg;
80
81         // Set to true (1) if the ATN flag was set, and we need to
82         // enter the MESSAGE_OUT phase.
83         int atnFlag;
84
85         // Set to true (1) if the RST flag was set.
86         volatile int resetFlag;
87
88         // Set to true (1) if the SEL flag was set.
89         volatile int selFlag;
90         
91         // Set to true (1) if a parity error was observed.
92     int parityError;
93
94         volatile int selDBX;
95
96         int phase;
97
98         uint8 data[MAX_SECTOR_SIZE * 2];
99         int dataPtr; // Index into data, reset on [re]selection to savedDataPtr
100         int savedDataPtr; // Index into data, initially 0.
101         int dataLen;
102
103         uint8 cdb[12]; // command descriptor block
104         uint8 cdbLen; // 6, 10, or 12 byte message.
105         int8 lun; // Target lun, set by IDENTIFY message.
106         uint8 discPriv; // Disconnect priviledge.
107         uint8_t compatMode; // SCSI_COMPAT_MODE
108
109         // Only let the reserved initiator talk to us.
110         // A 3rd party may be sending the RESERVE/RELEASE commands
111         int initiatorId; // 0 -> 7. Set during the selection phase.
112
113         // SCSI_STATUS value.
114         // Change to CHECK_CONDITION when setting a SENSE value
115         uint8 status;
116
117         uint8 msgIn;
118         uint8 msgOut;
119
120         void (*postDataOutHook)(void);
121
122         uint8 cmdCount;
123         uint8 selCount;
124         uint8 rstCount;
125         uint8 msgCount;
126         uint8 watchdogTick;
127         uint8 lastStatus;
128         uint8 lastSense;
129         uint16_t lastSenseASC;
130 } ScsiDevice;
131
132 extern ScsiDevice scsiDev;
133
134 void process_Status(void);
135 int process_MessageIn(int releaseBusFree);
136 void enter_BusFree(void);
137
138 void scsiInit(void);
139 void scsiPoll(void);
140 void scsiDisconnect(void);
141 int scsiReconnect(void);
142
143
144 // Utility macros, consistent with the Linux Kernel code.
145 #define likely(x)       __builtin_expect(!!(x), 1)
146 #define unlikely(x)     __builtin_expect(!!(x), 0)
147 //#define likely(x)       (x)
148 //#define unlikely(x)     (x)
149 #endif