Fix terrible performance
[SCSI2SD-V6.git] / src / firmware / 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 "geometry.h"
21 #include "sense.h"
22
23 #include <stdint.h>
24
25 typedef enum
26 {
27         // internal bits
28         __scsiphase_msg = 1,
29         __scsiphase_cd = 2,
30         __scsiphase_io = 4,
31
32         BUS_FREE = -1,
33         BUS_BUSY = -2,
34         ARBITRATION = -3,
35         SELECTION = -4,
36         RESELECTION = -5,
37         STATUS = __scsiphase_cd | __scsiphase_io,
38         COMMAND = __scsiphase_cd,
39         DATA_IN = __scsiphase_io,
40         DATA_OUT = 0,
41         MESSAGE_IN = __scsiphase_msg | __scsiphase_cd | __scsiphase_io,
42         MESSAGE_OUT = __scsiphase_msg | __scsiphase_cd
43 } SCSI_PHASE;
44
45 typedef enum
46 {
47         GOOD = 0,
48         CHECK_CONDITION = 2,
49         BUSY = 0x8,
50         INTERMEDIATE = 0x10,
51         CONFLICT = 0x18
52 } SCSI_STATUS;
53
54 typedef enum
55 {
56         MSG_COMMAND_COMPLETE = 0,
57         MSG_REJECT = 0x7,
58         MSG_LINKED_COMMAND_COMPLETE = 0x0A,
59         MSG_LINKED_COMMAND_COMPLETE_WITH_FLAG = 0x0B
60 } SCSI_MESSAGE;
61
62 typedef enum
63 {
64         COMPAT_UNKNOWN,
65         COMPAT_SCSI1,
66         COMPAT_SCSI2
67 } SCSI_COMPAT_MODE;
68
69 // Maximum value for bytes-per-sector.
70 #define MAX_SECTOR_SIZE 8192
71 #define MIN_SECTOR_SIZE 64
72
73 // Shadow parameters, possibly not saved to flash yet.
74 // Set via Mode Select
75 typedef struct
76 {
77         uint16_t bytesPerSector;
78 } LiveCfg;
79
80 typedef struct
81 {
82         uint8_t targetId;
83
84         const S2S_TargetCfg* cfg;
85
86         LiveCfg liveCfg;
87
88         ScsiSense sense;
89
90         uint16_t unitAttention; // Set to the sense qualifier key to be returned.
91
92         // Only let the reserved initiator talk to us.
93         // A 3rd party may be sending the RESERVE/RELEASE commands
94         int reservedId; // 0 -> 7 if reserved. -1 if not reserved.
95         int reserverId; // 0 -> 7 if reserved. -1 if not reserved.
96 } TargetState;
97
98 typedef struct
99 {
100         // TODO reduce this buffer size and add a proper cache
101         uint8_t data[MAX_SECTOR_SIZE * 8]; // Must be aligned for DMA
102
103         TargetState targets[S2S_MAX_TARGETS];
104         TargetState* target;
105         S2S_BoardCfg boardCfg;
106
107
108         // Set to true (1) if the ATN flag was set, and we need to
109         // enter the MESSAGE_OUT phase.
110         int atnFlag;
111
112         // Set to true (1) if the RST flag was set.
113         volatile int resetFlag;
114
115         // Set to true (1) if a parity error was observed.
116         int parityError;
117
118         int phase;
119
120         int dataPtr; // Index into data, reset on [re]selection to savedDataPtr
121         int savedDataPtr; // Index into data, initially 0.
122         int dataLen;
123
124         uint8_t cdb[12]; // command descriptor block
125         uint8_t cdbLen; // 6, 10, or 12 byte message.
126         int8_t lun; // Target lun, set by IDENTIFY message.
127         uint8_t discPriv; // Disconnect priviledge.
128         uint8_t compatMode; // SCSI_COMPAT_MODE
129
130         // Only let the reserved initiator talk to us.
131         // A 3rd party may be sending the RESERVE/RELEASE commands
132         int initiatorId; // 0 -> 7. Set during the selection phase.
133
134         // SCSI_STATUS value.
135         // Change to CHECK_CONDITION when setting a SENSE value
136         uint8_t status;
137
138         uint8_t msgIn;
139         uint8_t msgOut;
140
141         void (*postDataOutHook)(void);
142
143         uint8_t cmdCount;
144         uint8_t selCount;
145         uint8_t rstCount;
146         uint8_t msgCount;
147         uint8_t watchdogTick;
148         uint8_t lastStatus;
149         uint8_t lastSense;
150         uint16_t lastSenseASC;
151 } ScsiDevice;
152
153 extern ScsiDevice scsiDev;
154
155 void process_Status(void);
156 void process_MessageIn(void);
157
158 void scsiInit(void);
159 void scsiPoll(void);
160 void scsiDisconnect(void);
161 int scsiReconnect(void);
162
163
164 // Utility macros, consistent with the Linux Kernel code.
165 #define likely(x)       __builtin_expect(!!(x), 1)
166 #define unlikely(x)     __builtin_expect(!!(x), 0)
167 //#define likely(x)       (x)
168 //#define unlikely(x)     (x)
169 #endif