Fixed parity handling to respect the --no-parity config option.
[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 "geometry.h"
21 #include "sense.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 // Maximum value for bytes-per-sector.
61 #define MAX_SECTOR_SIZE 8192
62 #define MIN_SECTOR_SIZE 64
63
64 typedef struct
65 {
66         uint8_t scsiIdMask;
67
68         // Set to true (1) if the ATN flag was set, and we need to
69         // enter the MESSAGE_OUT phase.
70         volatile int atnFlag;
71
72         // Set to true (1) if the RST flag was set.
73         volatile int resetFlag;
74
75         // Set to true (1) if a parity error was observed.
76         int parityError;
77
78         int phase;
79
80         uint8 data[MAX_SECTOR_SIZE];
81         int dataPtr; // Index into data, reset on [re]selection to savedDataPtr
82         int savedDataPtr; // Index into data, initially 0.
83         int dataLen;
84
85         uint8 cdb[12]; // command descriptor block
86         uint8 cdbLen; // 6, 10, or 12 byte message.
87         int8 lun; // Target lun, set by IDENTIFY message.
88         uint8 discPriv; // Disconnect priviledge.
89         uint8_t compatMode; // true for SCSI1 and SASI hosts.
90
91         // Only let the reserved initiator talk to us.
92         // A 3rd party may be sending the RESERVE/RELEASE commands
93         int initiatorId; // 0 -> 7. Set during the selection phase.
94         int reservedId; // 0 -> 7 if reserved. -1 if not reserved.
95         int reserverId; // 0 -> 7 if reserved. -1 if not reserved.
96
97         // SCSI_STATUS value.
98         // Change to CHECK_CONDITION when setting a SENSE value
99         uint8 status;
100
101         ScsiSense sense;
102
103         uint16 unitAttention; // Set to the sense qualifier key to be returned.
104
105         uint8 msgIn;
106         uint8 msgOut;
107
108         void (*postDataOutHook)(void);
109
110         uint8 cmdCount;
111         uint8 selCount;
112         uint8 rstCount;
113         uint8 msgCount;
114         uint8 watchdogTick;
115         uint8 lastStatus;
116         uint8 lastSense;
117 } ScsiDevice;
118
119 extern ScsiDevice scsiDev;
120
121 void scsiInit(void);
122 void scsiPoll(void);
123 void scsiDisconnect(void);
124 int scsiReconnect(void);
125
126 #endif