Initial tape and magneto-optical support
[SCSI2SD.git] / software / include / scsi2sd.h
1 //      Copyright (C) 2014 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 scsi2sd_h
18 #define scsi2sd_h
19
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23
24 /* Common type definitions shared between the firmware and config tools
25
26         The configuration data is stored in flash.
27
28         The flash is organised as 2 arrays of 256 rows, with each row
29         having 256 bytes. Total of 128kb.
30
31         Linear flash memory map:
32         -----------------------------------------
33         Array 1 |Row 255 | Bootloader metadata
34                         ---------------------------------
35                         |Row 254 |
36                         |Row 252 | Blank
37                         ---------------------------------
38                         |Row 251 |
39                         | ...    |
40                         |Row 236 | Config target 3
41                         | ...    |
42                         |Row 220 | Config target 2
43                         | ...    |
44                         |Row 204 | Config target 1
45                         | ...    |
46                         |Row 188 | Config target 0
47                         ---------------------------------
48                         |Row 235 |
49                         | ...    |
50                         |Row 0   |
51         --------|        |
52         Array 0 |Row 255 | Blank
53                         ---------------------------------
54                         |Row 121 |
55                         | ...    |
56                         |Row 37  | Application
57                         ---------------------------------
58                         |Row 36  |
59                         | ...    |
60                         |Row 0   | Bootloader
61
62 */
63
64 #include "stdint.h"
65
66 #define MAX_SCSI_TARGETS 4
67 #define SCSI_CONFIG_ARRAY 1
68 #define SCSI_CONFIG_ROWS 16
69
70 // 256 bytes data, 32 bytes ECC
71 #define SCSI_CONFIG_ROW_SIZE 256
72 #define SCSI_CONFIG_ROW_ECC 288
73 #define SCSI_CONFIG_0_ROW 188
74 #define SCSI_CONFIG_1_ROW 204
75 #define SCSI_CONFIG_2_ROW 220
76 #define SCSI_CONFIG_3_ROW 236
77
78 typedef enum
79 {
80         CONFIG_TARGET_ID_BITS = 0x07,
81         CONFIG_TARGET_ENABLED = 0x80
82 } CONFIG_TARGET_FLAGS;
83
84 typedef enum
85 {
86         CONFIG_ENABLE_UNIT_ATTENTION = 1,
87         CONFIG_ENABLE_PARITY = 2,
88         CONFIG_ENABLE_SCSI2 = 4
89 } CONFIG_FLAGS;
90
91 typedef enum
92 {
93         CONFIG_FIXED,
94         CONFIG_REMOVEABLE,
95         CONFIG_OPTICAL,
96         CONFIG_FLOPPY_14MB,
97         CONFIG_MO,
98         CONFIG_SEQUENTIAL
99
100 } CONFIG_TYPE;
101
102 typedef enum
103 {
104         CONFIG_QUIRKS_NONE,
105         CONFIG_QUIRKS_APPLE
106 } CONFIG_QUIRKS;
107
108 typedef struct __attribute__((packed))
109 {
110         uint8_t deviceType;
111         uint8_t pageCode;
112         uint8_t reserved;
113         uint8_t pageLength;
114         uint8_t data[0]; // pageLength bytes.
115 } VPD;
116
117 typedef struct __attribute__((packed))
118 {
119         // bits 7 -> 3 = CONFIG_TARGET_FLAGS
120         // bits 2 -> 0 = target SCSI ID.
121         uint8_t scsiId;
122
123         uint8_t deviceType; // CONFIG_TYPE
124         uint8_t flags; // CONFIG_FLAGS
125         uint8_t deviceTypeModifier; // Used in INQUIRY response.
126
127         uint32_t sdSectorStart;
128         uint32_t scsiSectors;
129
130         uint16_t bytesPerSector;
131
132         // Max allowed by legacy IBM-PC bios is 6 bits (63)
133         uint16_t sectorsPerTrack;
134
135         // MS-Dos up to 7.10 will crash on >= 256 heads.
136         uint16_t headsPerCylinder;
137
138
139         char vendor[8];
140         char prodId[16];
141         char revision[4];
142         char serial[16];
143
144         uint16_t quirks; // CONFIG_QUIRKS
145
146         uint8_t reserved[960]; // Pad out to 1024 bytes for main section.
147
148         uint8_t vpd[3072]; // Total size is 4k.
149 } TargetConfig;
150
151 typedef enum
152 {
153         CONFIG_NONE, // Invalid
154
155         // Command content:
156         // uint8_t CONFIG_PING
157         // Response:
158         // CONFIG_STATUS
159         CONFIG_PING,
160
161         // Command content:
162         // uint8_t CONFIG_WRITEFLASH
163         // uint8_t[256] flashData
164         // uint8_t flashArray
165         // uint8_t flashRow
166         // Response:
167         // CONFIG_STATUS
168         CONFIG_WRITEFLASH,
169
170         // Command content:
171         // uint8_t CONFIG_READFLASH
172         // uint8_t flashArray
173         // uint8_t flashRow
174         // Response:
175         // 256 bytes of flash
176         CONFIG_READFLASH,
177
178         // Command content:
179         // uint8_t CONFIG_REBOOT
180         // Response: None.
181         CONFIG_REBOOT,
182
183         // Command content:
184         // uint8_t CONFIG_INFO
185         // Response:
186         // uint8_t[16] CSD
187         // uint8_t[16] CID
188         CONFIG_SDINFO,
189
190         // Command content:
191         // uint8_t CONFIG_SCSITEST
192         // Response:
193         // CONFIG_STATUS
194         // uint8_t result code (0 = passed)
195         CONFIG_SCSITEST
196 } CONFIG_COMMAND;
197
198 typedef enum
199 {
200         CONFIG_STATUS_GOOD,
201         CONFIG_STATUS_ERR
202 } CONFIG_STATUS;
203
204
205
206
207 #ifdef __cplusplus
208 } // extern "C"
209
210         #include <type_traits>
211         static_assert(
212                 std::is_pod<TargetConfig>::value, "Misuse of TargetConfig struct"
213                 );
214         static_assert(
215                 sizeof(TargetConfig) == 4096,
216                 "TargetConfig struct size mismatch"
217                 );
218
219 #endif
220
221 #endif