1 // Copyright (C) 2013 Michael McMaster <michael@codesrc.com>
\r
3 // This file is part of SCSI2SD.
\r
5 // SCSI2SD is free software: you can redistribute it and/or modify
\r
6 // it under the terms of the GNU General Public License as published by
\r
7 // the Free Software Foundation, either version 3 of the License, or
\r
8 // (at your option) any later version.
\r
10 // SCSI2SD is distributed in the hope that it will be useful,
\r
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
13 // GNU General Public License for more details.
\r
15 // You should have received a copy of the GNU General Public License
\r
16 // along with SCSI2SD. If not, see <http://www.gnu.org/licenses/>.
\r
20 #include "scsiPhy.h"
\r
23 #include "diagnostic.h"
\r
25 #include "inquiry.h"
\r
32 // Global SCSI device state.
\r
35 static void enter_SelectionPhase(void);
\r
36 static void process_SelectionPhase(void);
\r
37 static void enter_BusFree(void);
\r
38 static void enter_MessageIn(uint8 message);
\r
39 static void process_MessageIn(void);
\r
40 static void enter_Status(uint8 status);
\r
41 static void process_Status(void);
\r
42 static void enter_DataIn(int len);
\r
43 static void process_DataIn(void);
\r
44 static void process_DataOut(void);
\r
45 static void process_Command(void);
\r
47 static void doReserveRelease(void);
\r
49 static void enter_BusFree()
\r
51 scsiEnterPhase(BUS_FREE);
\r
55 scsiDev.phase = BUS_FREE;
\r
56 SCSI_ClearPin(SCSI_Out_BSY);
\r
59 static void enter_MessageIn(uint8 message)
\r
61 scsiDev.msgIn = message;
\r
62 scsiDev.phase = MESSAGE_IN;
\r
65 static void process_MessageIn()
\r
67 scsiEnterPhase(MESSAGE_IN);
\r
68 scsiWriteByte(scsiDev.msgIn);
\r
70 if (scsiDev.atnFlag)
\r
72 // If there was a parity error, we go
\r
73 // back to MESSAGE_OUT first, get out parity error message, then come
\r
76 else /*if (scsiDev.msgIn == MSG_COMMAND_COMPLETE)*/
\r
82 static void messageReject()
\r
84 scsiEnterPhase(MESSAGE_IN);
\r
85 scsiWriteByte(MSG_REJECT);
\r
88 static void enter_Status(uint8 status)
\r
90 scsiDev.status = status;
\r
91 scsiDev.phase = STATUS;
\r
94 static void process_Status()
\r
96 scsiEnterPhase(STATUS);
\r
97 scsiWriteByte(scsiDev.status);
\r
99 // Command Complete occurs AFTER a valid status has been
\r
100 // sent. then we go bus-free.
\r
101 enter_MessageIn(MSG_COMMAND_COMPLETE);
\r
104 static void enter_DataIn(int len)
\r
106 scsiDev.dataLen = len;
\r
107 scsiDev.phase = DATA_IN;
\r
110 static void process_DataIn()
\r
114 if (scsiDev.dataLen > sizeof(scsiDev.data))
\r
116 scsiDev.dataLen = sizeof(scsiDev.data);
\r
119 len = scsiDev.dataLen - scsiDev.dataPtr;
\r
122 scsiEnterPhase(DATA_IN);
\r
123 scsiWrite(scsiDev.data + scsiDev.dataPtr, len);
\r
124 scsiDev.dataPtr += len;
\r
127 if ((scsiDev.dataPtr >= scsiDev.dataLen) &&
\r
128 (transfer.currentBlock == transfer.blocks))
\r
130 enter_Status(GOOD);
\r
134 static void process_DataOut()
\r
138 if (scsiDev.dataLen > sizeof(scsiDev.data))
\r
140 scsiDev.dataLen = sizeof(scsiDev.data);
\r
143 scsiDev.parityError = 0;
\r
144 len = scsiDev.dataLen - scsiDev.dataPtr;
\r
147 scsiEnterPhase(DATA_OUT);
\r
149 scsiRead(scsiDev.data + scsiDev.dataPtr, len);
\r
150 scsiDev.dataPtr += len;
\r
152 // TODO re-implement parity checking
\r
153 if (0 && scsiDev.parityError && config->enableParity)
\r
155 scsiDev.sense.code = ABORTED_COMMAND;
\r
156 scsiDev.sense.asc = SCSI_PARITY_ERROR;
\r
157 enter_Status(CHECK_CONDITION);
\r
161 if ((scsiDev.dataPtr >= scsiDev.dataLen) &&
\r
162 (transfer.currentBlock == transfer.blocks))
\r
164 enter_Status(GOOD);
\r
168 static const uint8 CmdGroupBytes[8] = {6, 10, 10, 6, 6, 12, 6, 6};
\r
169 static void process_Command()
\r
176 scsiEnterPhase(COMMAND);
\r
177 scsiDev.parityError = 0;
\r
179 memset(scsiDev.cdb, 0, sizeof(scsiDev.cdb));
\r
180 scsiDev.cdb[0] = scsiReadByte();
\r
182 group = scsiDev.cdb[0] >> 5;
\r
183 cmdSize = CmdGroupBytes[group];
\r
184 scsiRead(scsiDev.cdb + 1, cmdSize - 1);
\r
186 command = scsiDev.cdb[0];
\r
187 lun = scsiDev.cdb[1] >> 5;
\r
189 if (scsiDev.parityError)
\r
191 scsiDev.sense.code = ABORTED_COMMAND;
\r
192 scsiDev.sense.asc = SCSI_PARITY_ERROR;
\r
193 enter_Status(CHECK_CONDITION);
\r
195 else if (command == 0x12)
\r
199 else if (command == 0x03)
\r
202 uint32 allocLength = scsiDev.cdb[4];
\r
203 if (allocLength == 0) allocLength = 256;
\r
204 memset(scsiDev.data, 0, 18);
\r
205 scsiDev.data[0] = 0xF0;
\r
206 scsiDev.data[2] = scsiDev.sense.code & 0x0F;
\r
208 // TODO populate "information" field with requested LBA.
\r
209 // TODO support more detailed sense data ?
\r
211 scsiDev.data[12] = scsiDev.sense.asc >> 8;
\r
212 scsiDev.data[13] = scsiDev.sense.asc;
\r
214 // Silently truncate results. SCSI-2 spec 8.2.14.
\r
215 enter_DataIn(allocLength < 18 ? allocLength : 18);
\r
217 // This is a good time to clear out old sense information.
\r
218 scsiDev.sense.code = NO_SENSE;
\r
219 scsiDev.sense.asc = NO_ADDITIONAL_SENSE_INFORMATION;
\r
221 // Some old SCSI drivers do NOT properly support
\r
222 // unitAttention. OTOH, Linux seems to require it
\r
223 // confirmed LCIII with unknown scsi driver fials here.
\r
224 else if (scsiDev.unitAttention && config->enableUnitAttention)
\r
226 scsiDev.sense.code = UNIT_ATTENTION;
\r
227 scsiDev.sense.asc = scsiDev.unitAttention;
\r
228 enter_Status(CHECK_CONDITION);
\r
232 scsiDev.sense.code = ILLEGAL_REQUEST;
\r
233 scsiDev.sense.asc = LOGICAL_UNIT_NOT_SUPPORTED;
\r
234 enter_Status(CHECK_CONDITION);
\r
236 else if (command == 0x17 || command == 0x16)
\r
238 doReserveRelease();
\r
240 else if ((scsiDev.reservedId >= 0) &&
\r
241 (scsiDev.reservedId != scsiDev.initiatorId))
\r
243 enter_Status(CONFLICT);
\r
245 else if (command == 0x1C)
\r
247 scsiReceiveDiagnostic();
\r
249 else if (command == 0x1D)
\r
251 scsiSendDiagnostic();
\r
254 !scsiModeCommand() &&
\r
255 !scsiDiskCommand())
\r
257 scsiDev.sense.code = ILLEGAL_REQUEST;
\r
258 scsiDev.sense.asc = INVALID_COMMAND_OPERATION_CODE;
\r
259 enter_Status(CHECK_CONDITION);
\r
263 if (scsiDev.phase == COMMAND) // No status set, and not in DATA_IN
\r
265 enter_Status(GOOD);
\r
269 static void doReserveRelease()
\r
271 int extentReservation = scsiDev.cdb[1] & 1;
\r
272 int thirdPty = scsiDev.cdb[1] & 0x10;
\r
273 int thirdPtyId = (scsiDev.cdb[1] >> 1) & 0x7;
\r
274 uint8 command = scsiDev.cdb[0];
\r
277 (!thirdPty && (scsiDev.initiatorId == scsiDev.reservedId)) ||
\r
279 (scsiDev.reserverId == scsiDev.initiatorId) &&
\r
280 (scsiDev.reservedId == thirdPtyId)
\r
283 if (extentReservation)
\r
286 scsiDev.sense.code = ILLEGAL_REQUEST;
\r
287 scsiDev.sense.asc = INVALID_FIELD_IN_CDB;
\r
288 enter_Status(CHECK_CONDITION);
\r
290 else if (command == 0x17) // release
\r
292 if ((scsiDev.reservedId < 0) || canRelease)
\r
294 scsiDev.reservedId = -1;
\r
295 scsiDev.reserverId = -1;
\r
299 enter_Status(CONFLICT);
\r
302 else // assume reserve.
\r
304 if ((scsiDev.reservedId < 0) || canRelease)
\r
306 scsiDev.reserverId = scsiDev.initiatorId;
\r
309 scsiDev.reservedId = thirdPtyId;
\r
313 scsiDev.reservedId = scsiDev.initiatorId;
\r
318 // Already reserved by someone else!
\r
319 enter_Status(CONFLICT);
\r
324 static void scsiReset()
\r
327 // done in verilog SCSI_Out_DBx_Write(0);
\r
328 SCSI_CTL_IO_Write(0);
\r
329 SCSI_ClearPin(SCSI_Out_ATN);
\r
330 SCSI_ClearPin(SCSI_Out_BSY);
\r
331 SCSI_ClearPin(SCSI_Out_ACK);
\r
332 SCSI_ClearPin(SCSI_Out_RST);
\r
333 SCSI_ClearPin(SCSI_Out_SEL);
\r
334 SCSI_ClearPin(SCSI_Out_REQ);
\r
335 SCSI_ClearPin(SCSI_Out_MSG);
\r
336 SCSI_ClearPin(SCSI_Out_CD);
\r
338 scsiDev.parityError = 0;
\r
339 scsiDev.phase = BUS_FREE;
\r
341 if (scsiDev.unitAttention != POWER_ON_RESET)
\r
343 scsiDev.unitAttention = SCSI_BUS_RESET;
\r
345 scsiDev.reservedId = -1;
\r
346 scsiDev.reserverId = -1;
\r
347 scsiDev.sense.code = NO_SENSE;
\r
348 scsiDev.sense.asc = NO_ADDITIONAL_SENSE_INFORMATION;
\r
351 // Sleep to allow the bus to settle down a bit.
\r
352 // We must be ready again within the "Reset to selection time" of
\r
354 // There is no guarantee that the RST line will be negated by then.
\r
355 // NOTE: We could be connected and powered by USB for configuration,
\r
356 // in which case TERMPWR cannot be supplied, and reset will ALWAYS
\r
358 CyDelay(10); // 10ms.
\r
359 scsiDev.resetFlag = SCSI_ReadPin(SCSI_RST_INT);
\r
360 scsiDev.atnFlag = 0;
\r
363 static void enter_SelectionPhase()
\r
365 // Ignore stale versions of this flag, but ensure we know the
\r
366 // current value if the flag is still set.
\r
367 scsiDev.atnFlag = SCSI_ReadPin(SCSI_ATN_INT);
\r
368 scsiDev.parityError = 0;
\r
369 scsiDev.dataPtr = 0;
\r
370 scsiDev.savedDataPtr = 0;
\r
371 scsiDev.dataLen = 0;
\r
372 scsiDev.status = GOOD;
\r
373 scsiDev.phase = SELECTION;
\r
375 transfer.blocks = 0;
\r
376 transfer.currentBlock = 0;
\r
379 static void process_SelectionPhase()
\r
381 uint8 mask = scsiReadDBxPins();
\r
382 int goodParity = (Lookup_OddParity[mask] == SCSI_ReadPin(SCSI_In_DBP));
\r
384 int sel = SCSI_ReadPin(SCSI_In_SEL);
\r
385 int bsy = SCSI_ReadPin(SCSI_In_BSY);
\r
387 (mask & scsiDev.scsiIdMask) &&
\r
388 (goodParity || !config->enableParity) && (countBits(mask) == 2))
\r
390 // We've been selected!
\r
391 // Assert BSY - Selection success!
\r
392 // must happen within 200us (Selection abort time) of seeing our
\r
394 // (Note: the initiator will be waiting the "Selection time-out delay"
\r
395 // for our BSY response, which is actually a very generous 250ms)
\r
396 SCSI_SetPin(SCSI_Out_BSY);
\r
399 // Wait until the end of the selection phase.
\r
400 while (!scsiDev.resetFlag)
\r
402 scsiDev.atnFlag |= SCSI_ReadPin(SCSI_ATN_INT);
\r
403 if (!SCSI_ReadPin(SCSI_In_SEL))
\r
409 // Save our initiator now that we're no longer in a time-critical
\r
413 uint8 initiatorMask = mask ^ scsiDev.scsiIdMask;
\r
414 scsiDev.initiatorId = 0;
\r
415 for (i = 0; i < 8; ++i)
\r
417 if (initiatorMask & (1 << i))
\r
419 scsiDev.initiatorId = i;
\r
425 scsiDev.phase = COMMAND;
\r
427 CyDelayUs(2); // DODGY HACK
\r
428 scsiDev.atnFlag |= SCSI_ReadPin(SCSI_ATN_INT);
\r
432 scsiDev.phase = BUS_BUSY;
\r
436 static void process_MessageOut()
\r
438 scsiEnterPhase(MESSAGE_OUT);
\r
440 scsiDev.atnFlag = 0;
\r
441 scsiDev.parityError = 0;
\r
442 scsiDev.msgOut = scsiReadByte();
\r
444 if (scsiDev.parityError)
\r
446 // Skip the remaining message bytes, and then start the MESSAGE_OUT
\r
447 // phase again from the start. The initiator will re-send the
\r
448 // same set of messages.
\r
449 while (SCSI_ReadPin(SCSI_ATN_INT) && !scsiDev.resetFlag)
\r
454 // Go-back and try the message again.
\r
455 scsiDev.atnFlag = 1;
\r
456 scsiDev.parityError = 0;
\r
458 else if (scsiDev.msgOut == 0x00)
\r
460 // COMMAND COMPLETE. but why would the target be receiving this ? nfi.
\r
463 else if (scsiDev.msgOut == 0x06)
\r
469 else if (scsiDev.msgOut == 0x0C)
\r
471 // BUS DEVICE RESET
\r
475 scsiDev.unitAttention = SCSI_BUS_RESET;
\r
477 // ANY initiator can reset the reservation state via this message.
\r
478 scsiDev.reservedId = -1;
\r
479 scsiDev.reserverId = -1;
\r
482 else if (scsiDev.msgOut == 0x05)
\r
484 // Initiate Detected Error
\r
487 else if (scsiDev.msgOut == 0x0F)
\r
489 // INITIATE RECOVERY
\r
492 else if (scsiDev.msgOut == 0x10)
\r
494 // RELEASE RECOVERY
\r
498 else if (scsiDev.msgOut == MSG_REJECT)
\r
502 scsiDev.resetFlag = 1;
\r
504 else if (scsiDev.msgOut == 0x08)
\r
508 else if (scsiDev.msgOut == 0x09)
\r
510 // Message Parity Error
\r
511 // Go back and re-send the last message.
\r
512 scsiDev.phase = MESSAGE_IN;
\r
514 else if (scsiDev.msgOut & 0x80) // 0x80 -> 0xFF
\r
517 // We don't disconnect, so ignore disconnect privilege.
\r
518 if ((scsiDev.msgOut & 0x18) || // Reserved bits set.
\r
519 (scsiDev.msgOut & 0x20) || // We don't have any target routines!
\r
520 (scsiDev.msgOut & 0x7) // We only support LUN 0!
\r
526 else if (scsiDev.msgOut >= 0x20 && scsiDev.msgOut <= 0x2F)
\r
528 // Two byte message. We don't support these. read and discard.
\r
531 else if (scsiDev.msgOut == 0x01)
\r
535 // Extended message.
\r
536 int msgLen = scsiReadByte();
\r
537 if (msgLen == 0) msgLen = 256;
\r
538 for (i = 0; i < msgLen && !scsiDev.resetFlag; ++i)
\r
544 // We don't support ANY extended messages.
\r
545 // Modify Data Pointer: We don't support reselection.
\r
546 // Wide Data Transfer Request: No. 8bit only.
\r
547 // Synchronous data transfer request. No, we can't do that.
\r
548 // We don't support any 2-byte messages either.
\r
549 // And we don't support any optional 1-byte messages.
\r
550 // In each case, the correct response is MESSAGE REJECT.
\r
558 // Re-check the ATN flag. We won't get another interrupt if
\r
559 // it stays asserted.
\r
560 CyDelayUs(2); // DODGY HACK
\r
561 scsiDev.atnFlag |= SCSI_ReadPin(SCSI_ATN_INT);
\r
566 // This is a hack until I work out why the ATN ISR isn't
\r
567 // running when it should.
\r
568 static int atnErrCount = 0;
\r
569 static int atnHitCount = 0;
\r
570 static void checkATN()
\r
572 int atn = SCSI_ReadPin(SCSI_ATN_INT);
\r
573 if (atn && !scsiDev.atnFlag)
\r
576 scsiDev.atnFlag = 1;
\r
578 else if (atn && scsiDev.atnFlag)
\r
584 void scsiPoll(void)
\r
586 if (scsiDev.resetFlag)
\r
591 switch (scsiDev.phase)
\r
594 if (SCSI_ReadPin(SCSI_In_BSY))
\r
596 scsiDev.phase = BUS_BUSY;
\r
601 // Someone is using the bus. Perhaps they are trying to
\r
603 if (SCSI_ReadPin(SCSI_In_SEL))
\r
605 enter_SelectionPhase();
\r
607 else if (!SCSI_ReadPin(SCSI_In_BSY))
\r
609 scsiDev.phase = BUS_FREE;
\r
614 // TODO Support reselection.
\r
618 process_SelectionPhase();
\r
622 // Not currently supported!
\r
627 if (scsiDev.atnFlag)
\r
629 process_MessageOut();
\r
639 if (scsiDev.atnFlag)
\r
641 process_MessageOut();
\r
651 if (scsiDev.atnFlag)
\r
653 process_MessageOut();
\r
663 if (scsiDev.atnFlag)
\r
665 process_MessageOut();
\r
675 if (scsiDev.atnFlag)
\r
677 process_MessageOut();
\r
681 process_MessageIn();
\r
687 process_MessageOut();
\r
694 scsiDev.scsiIdMask = 1 << (config->scsiId);
\r
696 scsiDev.atnFlag = 0;
\r
697 scsiDev.resetFlag = 1;
\r
698 scsiDev.phase = BUS_FREE;
\r
699 scsiDev.reservedId = -1;
\r
700 scsiDev.reserverId = -1;
\r
701 scsiDev.unitAttention = POWER_ON_RESET;
\r