d8f5d7c4dc999919d47d9a2dcbe3be08418a8e02
[SCSI2SD.git] / software / SCSI2SD / src / scsi.c
1 //      Copyright (C) 2014 Michael McMaster <michael@codesrc.com>\r
2 //\r
3 //      This file is part of SCSI2SD.\r
4 //\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
9 //\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
14 //\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
17 #pragma GCC push_options\r
18 #pragma GCC optimize("-flto")\r
19 \r
20 #include "device.h"\r
21 #include "scsi.h"\r
22 #include "scsiPhy.h"\r
23 #include "config.h"\r
24 #include "bits.h"\r
25 #include "diagnostic.h"\r
26 #include "disk.h"\r
27 #include "inquiry.h"\r
28 #include "led.h"\r
29 #include "mode.h"\r
30 #include "disk.h"\r
31 #include "time.h"\r
32 #include "cdrom.h"\r
33 #include "debug.h"\r
34 \r
35 #include <string.h>\r
36 \r
37 // Global SCSI device state.\r
38 ScsiDevice scsiDev;\r
39 \r
40 static void enter_SelectionPhase(void);\r
41 static void process_SelectionPhase(void);\r
42 static void enter_BusFree(void);\r
43 static void enter_MessageIn(uint8 message);\r
44 static void enter_Status(uint8 status);\r
45 static void enter_DataIn(int len);\r
46 static void process_DataIn(void);\r
47 static void process_DataOut(void);\r
48 static void process_Command(void);\r
49 \r
50 static void doReserveRelease(void);\r
51 \r
52 static void enter_BusFree()\r
53 {\r
54         // This delay probably isn't needed for most SCSI hosts, but it won't\r
55         // hurt either. It's possible some of the samplers needed this delay.\r
56         if (scsiDev.compatMode < COMPAT_SCSI2)\r
57         {\r
58                 CyDelayUs(2);\r
59         }\r
60 \r
61         if (scsiDev.status != GOOD && isDebugEnabled())\r
62         {\r
63                 // We want to capture debug information for failure cases.\r
64                 CyDelay(64);\r
65         }\r
66 \r
67         SCSI_ClearPin(SCSI_Out_BSY);\r
68         // We now have a Bus Clear Delay of 800ns to release remaining signals.\r
69         SCSI_CTL_PHASE_Write(0);\r
70 \r
71         // Wait for the initiator to cease driving signals\r
72         // Bus settle delay + bus clear delay = 1200ns\r
73         CyDelayUs(2);\r
74 \r
75         ledOff();\r
76         scsiDev.phase = BUS_FREE;\r
77 }\r
78 \r
79 static void enter_MessageIn(uint8 message)\r
80 {\r
81         scsiDev.msgIn = message;\r
82         scsiDev.phase = MESSAGE_IN;\r
83 }\r
84 \r
85 void process_MessageIn()\r
86 {\r
87         scsiEnterPhase(MESSAGE_IN);\r
88         scsiWriteByte(scsiDev.msgIn);\r
89 \r
90         if (unlikely(scsiDev.atnFlag))\r
91         {\r
92                 // If there was a parity error, we go\r
93                 // back to MESSAGE_OUT first, get out parity error message, then come\r
94                 // back here.\r
95         }\r
96         else if ((scsiDev.msgIn == MSG_LINKED_COMMAND_COMPLETE) ||\r
97                 (scsiDev.msgIn == MSG_LINKED_COMMAND_COMPLETE_WITH_FLAG))\r
98         {\r
99                 // Go back to the command phase and start again.\r
100                 scsiDev.phase = COMMAND;\r
101                 scsiDev.parityError = 0;\r
102                 scsiDev.dataPtr = 0;\r
103                 scsiDev.savedDataPtr = 0;\r
104                 scsiDev.dataLen = 0;\r
105                 scsiDev.status = GOOD;\r
106                 transfer.blocks = 0;\r
107                 transfer.currentBlock = 0;\r
108         }\r
109         else /*if (scsiDev.msgIn == MSG_COMMAND_COMPLETE)*/\r
110         {\r
111                 enter_BusFree();\r
112         }\r
113 }\r
114 \r
115 static void messageReject()\r
116 {\r
117         scsiEnterPhase(MESSAGE_IN);\r
118         scsiWriteByte(MSG_REJECT);\r
119 }\r
120 \r
121 static void enter_Status(uint8 status)\r
122 {\r
123         scsiDev.status = status;\r
124         scsiDev.phase = STATUS;\r
125 \r
126         scsiDev.lastStatus = scsiDev.status;\r
127         scsiDev.lastSense = scsiDev.target->sense.code;\r
128         scsiDev.lastSenseASC = scsiDev.target->sense.asc;\r
129 }\r
130 \r
131 void process_Status()\r
132 {\r
133         scsiEnterPhase(STATUS);\r
134 \r
135         uint8 message;\r
136 \r
137         uint8 control = scsiDev.cdb[scsiDev.cdbLen - 1];\r
138         if ((scsiDev.status == GOOD) && (control & 0x01))\r
139         {\r
140                 // Linked command.\r
141                 scsiDev.status = INTERMEDIATE;\r
142                 if (control & 0x02)\r
143                 {\r
144                         message = MSG_LINKED_COMMAND_COMPLETE_WITH_FLAG;\r
145                 }\r
146                 else\r
147                 {\r
148                         message = MSG_LINKED_COMMAND_COMPLETE;\r
149                 }\r
150         }\r
151         else\r
152         {\r
153                 message = MSG_COMMAND_COMPLETE;\r
154         }\r
155         scsiWriteByte(scsiDev.status);\r
156 \r
157         scsiDev.lastStatus = scsiDev.status;\r
158         scsiDev.lastSense = scsiDev.target->sense.code;\r
159         scsiDev.lastSenseASC = scsiDev.target->sense.asc;\r
160 \r
161 \r
162         // Command Complete occurs AFTER a valid status has been\r
163         // sent. then we go bus-free.\r
164         enter_MessageIn(message);\r
165 }\r
166 \r
167 static void enter_DataIn(int len)\r
168 {\r
169         scsiDev.dataLen = len;\r
170         scsiDev.phase = DATA_IN;\r
171 }\r
172 \r
173 static void process_DataIn()\r
174 {\r
175         uint32 len;\r
176 \r
177         if (scsiDev.dataLen > sizeof(scsiDev.data))\r
178         {\r
179                 scsiDev.dataLen = sizeof(scsiDev.data);\r
180         }\r
181 \r
182         len = scsiDev.dataLen - scsiDev.dataPtr;\r
183         if (len > 0)\r
184         {\r
185                 scsiEnterPhase(DATA_IN);\r
186                 scsiWrite(scsiDev.data + scsiDev.dataPtr, len);\r
187                 scsiDev.dataPtr += len;\r
188         }\r
189 \r
190         if ((scsiDev.dataPtr >= scsiDev.dataLen) &&\r
191                 (transfer.currentBlock == transfer.blocks))\r
192         {\r
193                 enter_Status(GOOD);\r
194         }\r
195 }\r
196 \r
197 static void process_DataOut()\r
198 {\r
199         uint32 len;\r
200 \r
201         if (scsiDev.dataLen > sizeof(scsiDev.data))\r
202         {\r
203                 scsiDev.dataLen = sizeof(scsiDev.data);\r
204         }\r
205 \r
206         scsiDev.parityError = 0;\r
207         len = scsiDev.dataLen - scsiDev.dataPtr;\r
208         if (len > 0)\r
209         {\r
210                 scsiEnterPhase(DATA_OUT);\r
211 \r
212                 scsiRead(scsiDev.data + scsiDev.dataPtr, len);\r
213                 scsiDev.dataPtr += len;\r
214 \r
215                 if (scsiDev.parityError &&\r
216                         (scsiDev.target->cfg->flags & CONFIG_ENABLE_PARITY) &&\r
217                         (scsiDev.compatMode >= COMPAT_SCSI2))\r
218                 {\r
219                         scsiDev.target->sense.code = ABORTED_COMMAND;\r
220                         scsiDev.target->sense.asc = SCSI_PARITY_ERROR;\r
221                         enter_Status(CHECK_CONDITION);\r
222                 }\r
223         }\r
224 \r
225         if ((scsiDev.dataPtr >= scsiDev.dataLen) &&\r
226                 (transfer.currentBlock == transfer.blocks))\r
227         {\r
228                 if (scsiDev.postDataOutHook != NULL)\r
229                 {\r
230                         scsiDev.postDataOutHook();\r
231                 }\r
232                 else\r
233                 {\r
234                         enter_Status(GOOD);\r
235                 }\r
236         }\r
237 }\r
238 \r
239 static const uint8 CmdGroupBytes[8] = {6, 10, 10, 6, 6, 12, 6, 6};\r
240 static void process_Command()\r
241 {\r
242         int group;\r
243         uint8 command;\r
244         uint8 control;\r
245 \r
246         scsiEnterPhase(COMMAND);\r
247         scsiDev.parityError = 0;\r
248 \r
249         memset(scsiDev.cdb, 0, sizeof(scsiDev.cdb));\r
250         scsiDev.cdb[0] = scsiReadByte();\r
251 \r
252         group = scsiDev.cdb[0] >> 5;\r
253         scsiDev.cdbLen = CmdGroupBytes[group];\r
254         scsiRead(scsiDev.cdb + 1, scsiDev.cdbLen - 1);\r
255 \r
256         command = scsiDev.cdb[0];\r
257 \r
258         // Prefer LUN's set by IDENTIFY messages for newer hosts.\r
259         if (scsiDev.lun < 0)\r
260         {\r
261                 scsiDev.lun = scsiDev.cdb[1] >> 5;\r
262         }\r
263 \r
264         control = scsiDev.cdb[scsiDev.cdbLen - 1];\r
265 \r
266         scsiDev.cmdCount++;\r
267 \r
268         if (unlikely(scsiDev.resetFlag))\r
269         {\r
270                 // Don't log bogus commands\r
271                 scsiDev.cmdCount--;\r
272                 memset(scsiDev.cdb, 0xff, sizeof(scsiDev.cdb));\r
273                 return;\r
274         }\r
275         else if (scsiDev.parityError &&\r
276                 (scsiDev.target->cfg->flags & CONFIG_ENABLE_PARITY) &&\r
277                 (scsiDev.compatMode >= COMPAT_SCSI2))\r
278         {\r
279                 scsiDev.target->sense.code = ABORTED_COMMAND;\r
280                 scsiDev.target->sense.asc = SCSI_PARITY_ERROR;\r
281                 enter_Status(CHECK_CONDITION);\r
282         }\r
283         else if ((control & 0x02) && ((control & 0x01) == 0))\r
284         {\r
285                 // FLAG set without LINK flag.\r
286                 scsiDev.target->sense.code = ILLEGAL_REQUEST;\r
287                 scsiDev.target->sense.asc = INVALID_FIELD_IN_CDB;\r
288                 enter_Status(CHECK_CONDITION);\r
289         }\r
290         else if (command == 0x12)\r
291         {\r
292                 scsiInquiry();\r
293         }\r
294         else if (command == 0x03)\r
295         {\r
296                 // REQUEST SENSE\r
297                 uint32 allocLength = scsiDev.cdb[4];\r
298 \r
299                 // As specified by the SASI and SCSI1 standard.\r
300                 // Newer initiators won't be specifying 0 anyway.\r
301                 if (allocLength == 0) allocLength = 4;\r
302 \r
303                 memset(scsiDev.data, 0, 256); // Max possible alloc length\r
304                 scsiDev.data[0] = 0xF0;\r
305                 scsiDev.data[2] = scsiDev.target->sense.code & 0x0F;\r
306 \r
307                 scsiDev.data[3] = transfer.lba >> 24;\r
308                 scsiDev.data[4] = transfer.lba >> 16;\r
309                 scsiDev.data[5] = transfer.lba >> 8;\r
310                 scsiDev.data[6] = transfer.lba;\r
311 \r
312                 // Additional bytes if there are errors to report\r
313                 scsiDev.data[7] = 10; // additional length\r
314                 scsiDev.data[12] = scsiDev.target->sense.asc >> 8;\r
315                 scsiDev.data[13] = scsiDev.target->sense.asc;\r
316 \r
317                 // Silently truncate results. SCSI-2 spec 8.2.14.\r
318                 enter_DataIn(allocLength);\r
319 \r
320                 // This is a good time to clear out old sense information.\r
321                 scsiDev.target->sense.code = NO_SENSE;\r
322                 scsiDev.target->sense.asc = NO_ADDITIONAL_SENSE_INFORMATION;\r
323         }\r
324         // Some old SCSI drivers do NOT properly support\r
325         // unitAttention. eg. the Mac Plus would trigger a SCSI reset\r
326         // on receiving the unit attention response on boot, thus\r
327         // triggering another unit attention condition.\r
328         else if (scsiDev.target->unitAttention &&\r
329                 (scsiDev.target->cfg->flags & CONFIG_ENABLE_UNIT_ATTENTION))\r
330         {\r
331                 scsiDev.target->sense.code = UNIT_ATTENTION;\r
332                 scsiDev.target->sense.asc = scsiDev.target->unitAttention;\r
333 \r
334                 // If initiator doesn't do REQUEST SENSE for the next command, then\r
335                 // data is lost.\r
336                 scsiDev.target->unitAttention = 0;\r
337 \r
338                 enter_Status(CHECK_CONDITION);\r
339         }\r
340         else if (scsiDev.lun)\r
341         {\r
342                 scsiDev.target->sense.code = ILLEGAL_REQUEST;\r
343                 scsiDev.target->sense.asc = LOGICAL_UNIT_NOT_SUPPORTED;\r
344                 enter_Status(CHECK_CONDITION);\r
345         }\r
346         else if (command == 0x17 || command == 0x16)\r
347         {\r
348                 doReserveRelease();\r
349         }\r
350         else if ((scsiDev.target->reservedId >= 0) &&\r
351                 (scsiDev.target->reservedId != scsiDev.initiatorId))\r
352         {\r
353                 enter_Status(CONFLICT);\r
354         }\r
355         else if (scsiDiskCommand())\r
356         {\r
357                 // Already handled.\r
358                 // check for the performance-critical read/write\r
359                 // commands ASAP.\r
360         }\r
361         else if (command == 0x1C)\r
362         {\r
363                 scsiReceiveDiagnostic();\r
364         }\r
365         else if (command == 0x1D)\r
366         {\r
367                 scsiSendDiagnostic();\r
368         }\r
369         else if (command == 0x3B)\r
370         {\r
371                 scsiWriteBuffer();\r
372         }\r
373         else if (command == 0x3C)\r
374         {\r
375                 scsiReadBuffer();\r
376         }\r
377         else if (\r
378                 !scsiCDRomCommand() &&\r
379                 !scsiModeCommand())\r
380         {\r
381                 scsiDev.target->sense.code = ILLEGAL_REQUEST;\r
382                 scsiDev.target->sense.asc = INVALID_COMMAND_OPERATION_CODE;\r
383                 enter_Status(CHECK_CONDITION);\r
384         }\r
385 \r
386         // Successful\r
387         if (scsiDev.phase == COMMAND) // No status set, and not in DATA_IN\r
388         {\r
389                 enter_Status(GOOD);\r
390         }\r
391 \r
392 }\r
393 \r
394 static void doReserveRelease()\r
395 {\r
396         int extentReservation = scsiDev.cdb[1] & 1;\r
397         int thirdPty = scsiDev.cdb[1] & 0x10;\r
398         int thirdPtyId = (scsiDev.cdb[1] >> 1) & 0x7;\r
399         uint8 command = scsiDev.cdb[0];\r
400 \r
401         int canRelease =\r
402                 (!thirdPty && (scsiDev.initiatorId == scsiDev.target->reservedId)) ||\r
403                         (thirdPty &&\r
404                                 (scsiDev.target->reserverId == scsiDev.initiatorId) &&\r
405                                 (scsiDev.target->reservedId == thirdPtyId)\r
406                         );\r
407 \r
408         if (extentReservation)\r
409         {\r
410                 // Not supported.\r
411                 scsiDev.target->sense.code = ILLEGAL_REQUEST;\r
412                 scsiDev.target->sense.asc = INVALID_FIELD_IN_CDB;\r
413                 enter_Status(CHECK_CONDITION);\r
414         }\r
415         else if (command == 0x17) // release\r
416         {\r
417                 if ((scsiDev.target->reservedId < 0) || canRelease)\r
418                 {\r
419                         scsiDev.target->reservedId = -1;\r
420                         scsiDev.target->reserverId = -1;\r
421                 }\r
422                 else\r
423                 {\r
424                         enter_Status(CONFLICT);\r
425                 }\r
426         }\r
427         else // assume reserve.\r
428         {\r
429                 if ((scsiDev.target->reservedId < 0) || canRelease)\r
430                 {\r
431                         scsiDev.target->reserverId = scsiDev.initiatorId;\r
432                         if (thirdPty)\r
433                         {\r
434                                 scsiDev.target->reservedId = thirdPtyId;\r
435                         }\r
436                         else\r
437                         {\r
438                                 scsiDev.target->reservedId = scsiDev.initiatorId;\r
439                         }\r
440                 }\r
441                 else\r
442                 {\r
443                         // Already reserved by someone else!\r
444                         enter_Status(CONFLICT);\r
445                 }\r
446         }\r
447 }\r
448 \r
449 static void scsiReset()\r
450 {\r
451         scsiDev.rstCount++;\r
452         ledOff();\r
453 \r
454         scsiPhyReset();\r
455         SCSI_Out_Ctl_Write(0);\r
456 \r
457         scsiDev.parityError = 0;\r
458         scsiDev.phase = BUS_FREE;\r
459         scsiDev.atnFlag = 0;\r
460         scsiDev.resetFlag = 0;\r
461         scsiDev.lun = -1;\r
462         scsiDev.compatMode = COMPAT_UNKNOWN;\r
463 \r
464         if (scsiDev.target)\r
465         {\r
466                 if (scsiDev.target->unitAttention != POWER_ON_RESET)\r
467                 {\r
468                         scsiDev.target->unitAttention = SCSI_BUS_RESET;\r
469                 }\r
470                 scsiDev.target->reservedId = -1;\r
471                 scsiDev.target->reserverId = -1;\r
472                 scsiDev.target->sense.code = NO_SENSE;\r
473                 scsiDev.target->sense.asc = NO_ADDITIONAL_SENSE_INFORMATION;\r
474         }\r
475         scsiDev.target = NULL;\r
476         scsiDiskReset();\r
477 \r
478         scsiDev.postDataOutHook = NULL;\r
479 \r
480         // Sleep to allow the bus to settle down a bit.\r
481         // We must be ready again within the "Reset to selection time" of\r
482         // 250ms.\r
483         // There is no guarantee that the RST line will be negated by then.\r
484         // NOTE: We could be connected and powered by USB for configuration,\r
485         // in which case TERMPWR cannot be supplied, and reset will ALWAYS\r
486         // be true. Therefore, the sleep here must be slow to avoid slowing\r
487         // USB comms\r
488         CyDelay(1); // 1ms.\r
489 }\r
490 \r
491 static void enter_SelectionPhase()\r
492 {\r
493         // Ignore stale versions of this flag, but ensure we know the\r
494         // current value if the flag is still set.\r
495         scsiDev.atnFlag = 0;\r
496         scsiDev.parityError = 0;\r
497         scsiDev.dataPtr = 0;\r
498         scsiDev.savedDataPtr = 0;\r
499         scsiDev.dataLen = 0;\r
500         scsiDev.status = GOOD;\r
501         scsiDev.phase = SELECTION;\r
502         scsiDev.lun = -1;\r
503         scsiDev.discPriv = 0;\r
504 \r
505         scsiDev.initiatorId = -1;\r
506         scsiDev.target = NULL;\r
507 \r
508         transfer.blocks = 0;\r
509         transfer.currentBlock = 0;\r
510 \r
511         scsiDev.postDataOutHook = NULL;\r
512 }\r
513 \r
514 static void process_SelectionPhase()\r
515 {\r
516         if (scsiDev.compatMode < COMPAT_SCSI2)\r
517         {\r
518                 // Required for some older SCSI1 devices using a 5380 chip.\r
519                 CyDelay(1);\r
520         }\r
521 \r
522         int sel = SCSI_ReadFilt(SCSI_Filt_SEL);\r
523         int bsy = SCSI_ReadFilt(SCSI_Filt_BSY);\r
524 \r
525         // Only read these pins AFTER SEL and BSY - we don't want to catch them\r
526         // during a transition period.\r
527         uint8 mask = scsiReadDBxPins();\r
528         int maskBitCount = countBits(mask);\r
529         int goodParity = (Lookup_OddParity[mask] == SCSI_ReadPin(SCSI_In_DBP));\r
530         int atnFlag = SCSI_ReadFilt(SCSI_Filt_ATN);\r
531 \r
532         int tgtIndex;\r
533         TargetState* target = NULL;\r
534         for (tgtIndex = 0; tgtIndex < MAX_SCSI_TARGETS; ++tgtIndex)\r
535         {\r
536                 if (mask & (1 << scsiDev.targets[tgtIndex].targetId))\r
537                 {\r
538                         target = &scsiDev.targets[tgtIndex];\r
539                         break;\r
540                 }\r
541         }\r
542         if (!bsy && sel &&\r
543                 target &&\r
544                 (goodParity || !(target->cfg->flags & CONFIG_ENABLE_PARITY) || !atnFlag) &&\r
545                 likely(maskBitCount <= 2))\r
546         {\r
547                 scsiDev.target = target;\r
548 \r
549                 // Do we enter MESSAGE OUT immediately ? SCSI 1 and 2 standards says\r
550                 // move to MESSAGE OUT if ATN is true before we assert BSY.\r
551                 // The initiator should assert ATN with SEL.\r
552                 scsiDev.atnFlag = atnFlag;\r
553 \r
554                 // Unit attention breaks many older SCSI hosts. Disable it completely\r
555                 // for SCSI-1 (and older) hosts, regardless of our configured setting.\r
556                 // Enable the compatability mode also as many SASI and SCSI1\r
557                 // controllers don't generate parity bits.\r
558                 if (!scsiDev.atnFlag)\r
559                 {\r
560                         target->unitAttention = 0;\r
561                         scsiDev.compatMode = COMPAT_SCSI1;\r
562                 }\r
563                 else if (!(target->cfg->flags & CONFIG_ENABLE_SCSI2))\r
564                 {\r
565                         scsiDev.compatMode = COMPAT_SCSI1;\r
566                 }\r
567                 else if (scsiDev.compatMode == COMPAT_UNKNOWN)\r
568                 {\r
569                         scsiDev.compatMode = COMPAT_SCSI2;\r
570                 }\r
571 \r
572                 // We've been selected!\r
573                 // Assert BSY - Selection success!\r
574                 // must happen within 200us (Selection abort time) of seeing our\r
575                 // ID + SEL.\r
576                 // (Note: the initiator will be waiting the "Selection time-out delay"\r
577                 // for our BSY response, which is actually a very generous 250ms)\r
578                 SCSI_SetPin(SCSI_Out_BSY);\r
579                 ledOn();\r
580 \r
581                 scsiDev.selCount++;\r
582 \r
583                 // Wait until the end of the selection phase.\r
584                 while (likely(!scsiDev.resetFlag))\r
585                 {\r
586                         if (!SCSI_ReadFilt(SCSI_Filt_SEL))\r
587                         {\r
588                                 break;\r
589                         }\r
590                 }\r
591 \r
592                 // Save our initiator now that we're no longer in a time-critical\r
593                 // section.\r
594                 // SCSI1/SASI initiators may not set their own ID.\r
595                 {\r
596                         int i;\r
597                         uint8_t initiatorMask = mask ^ (1 << target->targetId);\r
598                         scsiDev.initiatorId = -1;\r
599                         for (i = 0; i < 8; ++i)\r
600                         {\r
601                                 if (initiatorMask & (1 << i))\r
602                                 {\r
603                                         scsiDev.initiatorId = i;\r
604                                         break;\r
605                                 }\r
606                         }\r
607                 }\r
608 \r
609                 scsiDev.phase = COMMAND;\r
610         }\r
611         else if (!sel)\r
612         {\r
613                 scsiDev.phase = BUS_BUSY;\r
614         }\r
615 }\r
616 \r
617 static void process_MessageOut()\r
618 {\r
619         scsiEnterPhase(MESSAGE_OUT);\r
620 \r
621         scsiDev.atnFlag = 0;\r
622         scsiDev.parityError = 0;\r
623         scsiDev.msgOut = scsiReadByte();\r
624         scsiDev.msgCount++;\r
625 \r
626         if (scsiDev.parityError &&\r
627                 (scsiDev.target->cfg->flags & CONFIG_ENABLE_PARITY) &&\r
628                 (scsiDev.compatMode >= COMPAT_SCSI2))\r
629         {\r
630                 // Skip the remaining message bytes, and then start the MESSAGE_OUT\r
631                 // phase again from the start. The initiator will re-send the\r
632                 // same set of messages.\r
633                 while (SCSI_ReadFilt(SCSI_Filt_ATN) && !scsiDev.resetFlag)\r
634                 {\r
635                         scsiReadByte();\r
636                 }\r
637 \r
638                 // Go-back and try the message again.\r
639                 scsiDev.atnFlag = 1;\r
640                 scsiDev.parityError = 0;\r
641         }\r
642         else if (scsiDev.msgOut == 0x00)\r
643         {\r
644                 // COMMAND COMPLETE. but why would the target be receiving this ? nfi.\r
645                 enter_BusFree();\r
646         }\r
647         else if (scsiDev.msgOut == 0x06)\r
648         {\r
649                 // ABORT\r
650                 scsiDiskReset();\r
651                 enter_BusFree();\r
652         }\r
653         else if (scsiDev.msgOut == 0x0C)\r
654         {\r
655                 // BUS DEVICE RESET\r
656 \r
657                 scsiDiskReset();\r
658 \r
659                 scsiDev.target->unitAttention = SCSI_BUS_RESET;\r
660 \r
661                 // ANY initiator can reset the reservation state via this message.\r
662                 scsiDev.target->reservedId = -1;\r
663                 scsiDev.target->reserverId = -1;\r
664                 enter_BusFree();\r
665         }\r
666         else if (scsiDev.msgOut == 0x05)\r
667         {\r
668                 // Initiate Detected Error\r
669                 // Ignore for now\r
670         }\r
671         else if (scsiDev.msgOut == 0x0F)\r
672         {\r
673                 // INITIATE RECOVERY\r
674                 // Ignore for now\r
675         }\r
676         else if (scsiDev.msgOut == 0x10)\r
677         {\r
678                 // RELEASE RECOVERY\r
679                 // Ignore for now\r
680                 enter_BusFree();\r
681         }\r
682         else if (scsiDev.msgOut == MSG_REJECT)\r
683         {\r
684                 // Message Reject\r
685                 // Oh well.\r
686                 scsiDev.resetFlag = 1;\r
687         }\r
688         else if (scsiDev.msgOut == 0x08)\r
689         {\r
690                 // NOP\r
691         }\r
692         else if (scsiDev.msgOut == 0x09)\r
693         {\r
694                 // Message Parity Error\r
695                 // Go back and re-send the last message.\r
696                 scsiDev.phase = MESSAGE_IN;\r
697         }\r
698         else if (scsiDev.msgOut & 0x80) // 0x80 -> 0xFF\r
699         {\r
700                 // IDENTIFY\r
701                 if ((scsiDev.msgOut & 0x18) || // Reserved bits set.\r
702                         (scsiDev.msgOut & 0x20))  // We don't have any target routines!\r
703                 {\r
704                         messageReject();\r
705                 }\r
706 \r
707                 scsiDev.lun = scsiDev.msgOut & 0x7;\r
708                 scsiDev.discPriv = \r
709                         ((scsiDev.msgOut & 0x40) && (scsiDev.initiatorId >= 0))\r
710                                 ? 1 : 0;\r
711         }\r
712         else if (scsiDev.msgOut >= 0x20 && scsiDev.msgOut <= 0x2F)\r
713         {\r
714                 // Two byte message. We don't support these. read and discard.\r
715                 scsiReadByte();\r
716         }\r
717         else if (scsiDev.msgOut == 0x01)\r
718         {\r
719                 int i;\r
720 \r
721                 // Extended message.\r
722                 int msgLen = scsiReadByte();\r
723                 if (msgLen == 0) msgLen = 256;\r
724                 uint8_t extmsg[256];\r
725                 for (i = 0; i < msgLen && !scsiDev.resetFlag; ++i)\r
726                 {\r
727                         // Discard bytes.\r
728                         extmsg[i] = scsiReadByte();\r
729                 }\r
730 \r
731                 if (extmsg[0] == 3 && msgLen == 2) // Wide Data Request\r
732                 {\r
733                         // Negotiate down to 8bit\r
734                         scsiEnterPhase(MESSAGE_IN);\r
735                         static const uint8_t WDTR[] = {0x01, 0x02, 0x03, 0x00};\r
736                         scsiWrite(WDTR, sizeof(WDTR));\r
737                 }\r
738                 else if (extmsg[0] == 1 && msgLen == 3) // Synchronous data request\r
739                 {\r
740                         // Negotiate back to async\r
741                         scsiEnterPhase(MESSAGE_IN);\r
742                         static const uint8_t SDTR[] = {0x01, 0x03, 0x01, 0x00, 0x00};\r
743                         scsiWrite(SDTR, sizeof(SDTR));\r
744                 }\r
745                 else\r
746                 {\r
747                         // Not supported\r
748                         messageReject();\r
749                 }\r
750         }\r
751         else\r
752         {\r
753                 messageReject();\r
754         }\r
755 \r
756         // Re-check the ATN flag in case it stays asserted.\r
757         scsiDev.atnFlag |= SCSI_ReadFilt(SCSI_Filt_ATN);\r
758 }\r
759 \r
760 void scsiPoll(void)\r
761 {\r
762         if (unlikely(scsiDev.resetFlag))\r
763         {\r
764                 scsiReset();\r
765                 if ((scsiDev.resetFlag = SCSI_ReadFilt(SCSI_Filt_RST)))\r
766                 {\r
767                         // Still in reset phase. Do not try and process any commands.\r
768                         return;\r
769                 }\r
770         }\r
771 \r
772         switch (scsiDev.phase)\r
773         {\r
774         case BUS_FREE:\r
775                 if (SCSI_ReadFilt(SCSI_Filt_BSY))\r
776                 {\r
777                         scsiDev.phase = BUS_BUSY;\r
778                 }\r
779                 // The Arbitration phase is optional for SCSI1/SASI hosts if there is only\r
780                 // one initiator in the chain. Support this by moving\r
781                 // straight to selection if SEL is asserted.\r
782                 // ie. the initiator won't assert BSY and it's own ID before moving to selection.\r
783                 else if (SCSI_ReadFilt(SCSI_Filt_SEL))\r
784                 {\r
785                         enter_SelectionPhase();\r
786                 }\r
787         break;\r
788 \r
789         case BUS_BUSY:\r
790                 // Someone is using the bus. Perhaps they are trying to\r
791                 // select us.\r
792                 if (SCSI_ReadFilt(SCSI_Filt_SEL))\r
793                 {\r
794                         enter_SelectionPhase();\r
795                 }\r
796                 else if (!SCSI_ReadFilt(SCSI_Filt_BSY))\r
797                 {\r
798                         scsiDev.phase = BUS_FREE;\r
799                 }\r
800         break;\r
801 \r
802         case ARBITRATION:\r
803                 // TODO Support reselection.\r
804                 break;\r
805 \r
806         case SELECTION:\r
807                 process_SelectionPhase();\r
808         break;\r
809 \r
810         case RESELECTION:\r
811                 // Not currently supported!\r
812         break;\r
813 \r
814         case COMMAND:\r
815                 // Do not check ATN here. SCSI 1 & 2 initiators must set ATN\r
816                 // and SEL together upon entering the selection phase if they\r
817                 // want to send a message (IDENTIFY) immediately.\r
818                 if (scsiDev.atnFlag)\r
819                 {\r
820                         process_MessageOut();\r
821                 }\r
822                 else\r
823                 {\r
824                         process_Command();\r
825                 }\r
826         break;\r
827 \r
828         case DATA_IN:\r
829                 scsiDev.atnFlag |= SCSI_ReadFilt(SCSI_Filt_ATN);\r
830                 if (scsiDev.atnFlag)\r
831                 {\r
832                         process_MessageOut();\r
833                 }\r
834                 else\r
835                 {\r
836                         process_DataIn();\r
837                 }\r
838         break;\r
839 \r
840         case DATA_OUT:\r
841                 scsiDev.atnFlag |= SCSI_ReadFilt(SCSI_Filt_ATN);\r
842                 if (scsiDev.atnFlag)\r
843                 {\r
844                         process_MessageOut();\r
845                 }\r
846                 else\r
847                 {\r
848                         process_DataOut();\r
849                 }\r
850         break;\r
851 \r
852         case STATUS:\r
853                 scsiDev.atnFlag |= SCSI_ReadFilt(SCSI_Filt_ATN);\r
854                 if (scsiDev.atnFlag)\r
855                 {\r
856                         process_MessageOut();\r
857                 }\r
858                 else\r
859                 {\r
860                         process_Status();\r
861                 }\r
862         break;\r
863 \r
864         case MESSAGE_IN:\r
865                 scsiDev.atnFlag |= SCSI_ReadFilt(SCSI_Filt_ATN);\r
866                 if (scsiDev.atnFlag)\r
867                 {\r
868                         process_MessageOut();\r
869                 }\r
870                 else\r
871                 {\r
872                         process_MessageIn();\r
873                 }\r
874 \r
875         break;\r
876 \r
877         case MESSAGE_OUT:\r
878                 process_MessageOut();\r
879         break;\r
880         }\r
881 }\r
882 \r
883 void scsiInit()\r
884 {\r
885         scsiDev.atnFlag = 0;\r
886         scsiDev.resetFlag = 1;\r
887         scsiDev.phase = BUS_FREE;\r
888         scsiDev.target = NULL;\r
889         scsiDev.compatMode = COMPAT_UNKNOWN;\r
890 \r
891         int i;\r
892         for (i = 0; i < MAX_SCSI_TARGETS; ++i)\r
893         {\r
894                 const TargetConfig* cfg = getConfigByIndex(i);\r
895                 if (cfg && (cfg->scsiId & CONFIG_TARGET_ENABLED))\r
896                 {\r
897                         scsiDev.targets[i].targetId = cfg->scsiId & CONFIG_TARGET_ID_BITS;\r
898                         scsiDev.targets[i].cfg = cfg;\r
899 \r
900                         scsiDev.targets[i].liveCfg.bytesPerSector = cfg->bytesPerSector;\r
901                 }\r
902                 else\r
903                 {\r
904                         scsiDev.targets[i].targetId = 0xff;\r
905                         scsiDev.targets[i].cfg = NULL;\r
906                 }\r
907                 scsiDev.targets[i].reservedId = -1;\r
908                 scsiDev.targets[i].reserverId = -1;\r
909                 scsiDev.targets[i].unitAttention = POWER_ON_RESET;\r
910                 scsiDev.targets[i].sense.code = NO_SENSE;\r
911                 scsiDev.targets[i].sense.asc = NO_ADDITIONAL_SENSE_INFORMATION;\r
912         }\r
913 }\r
914 \r
915 void scsiDisconnect()\r
916 {\r
917         scsiEnterPhase(MESSAGE_IN);\r
918         scsiWriteByte(0x02); // save data pointer\r
919         scsiWriteByte(0x04); // disconnect msg.\r
920 \r
921         // For now, the caller is responsible for tracking the disconnected\r
922         // state, and calling scsiReconnect.\r
923         // Ideally the client would exit their loop and we'd implement this\r
924         // as part of scsiPoll\r
925         int phase = scsiDev.phase;\r
926         enter_BusFree();\r
927         scsiDev.phase = phase;\r
928 }\r
929 \r
930 int scsiReconnect()\r
931 {\r
932         int reconnected = 0;\r
933 \r
934         int sel = SCSI_ReadFilt(SCSI_Filt_SEL);\r
935         int bsy = SCSI_ReadFilt(SCSI_Filt_BSY);\r
936         if (!sel && !bsy)\r
937         {\r
938                 CyDelayUs(1);\r
939                 sel = SCSI_ReadFilt(SCSI_Filt_SEL);\r
940                 bsy = SCSI_ReadFilt(SCSI_Filt_BSY);\r
941         }\r
942 \r
943         if (!sel && !bsy)\r
944         {\r
945                 // Arbitrate.\r
946                 ledOn();\r
947                 uint8_t scsiIdMask = 1 << scsiDev.target->targetId;\r
948                 SCSI_Out_Bits_Write(scsiIdMask);\r
949                 SCSI_Out_Ctl_Write(1); // Write bits manually.\r
950                 SCSI_SetPin(SCSI_Out_BSY);\r
951 \r
952                 CyDelayUs(3); // arbitrate delay. 2.4us.\r
953 \r
954                 uint8_t dbx = scsiReadDBxPins();\r
955                 sel = SCSI_ReadFilt(SCSI_Filt_SEL);\r
956                 if (sel || ((dbx ^ scsiIdMask) > scsiIdMask))\r
957                 {\r
958                         // Lost arbitration.\r
959                         SCSI_Out_Ctl_Write(0);\r
960                         SCSI_ClearPin(SCSI_Out_BSY);\r
961                         ledOff();\r
962                 }\r
963                 else\r
964                 {\r
965                         // Won arbitration\r
966                         SCSI_SetPin(SCSI_Out_SEL);\r
967                         CyDelayUs(1); // Bus clear + Bus settle.\r
968 \r
969                         // Reselection phase\r
970                         SCSI_CTL_PHASE_Write(__scsiphase_io);\r
971                         SCSI_Out_Bits_Write(scsiIdMask | (1 << scsiDev.initiatorId));\r
972                         scsiDeskewDelay(); // 2 deskew delays\r
973                         scsiDeskewDelay(); // 2 deskew delays\r
974                         SCSI_ClearPin(SCSI_Out_BSY);\r
975                         CyDelayUs(1);  // Bus Settle Delay\r
976 \r
977                         uint32_t waitStart_ms = getTime_ms();\r
978                         bsy = SCSI_ReadFilt(SCSI_Filt_BSY);\r
979                         // Wait for initiator.\r
980                         while (\r
981                                 !bsy &&\r
982                                 !scsiDev.resetFlag &&\r
983                                 (elapsedTime_ms(waitStart_ms) < 250))\r
984                         {\r
985                                 bsy = SCSI_ReadFilt(SCSI_Filt_BSY);\r
986                         }\r
987 \r
988                         if (bsy)\r
989                         {\r
990                                 SCSI_SetPin(SCSI_Out_BSY);\r
991                                 scsiDeskewDelay(); // 2 deskew delays\r
992                                 scsiDeskewDelay(); // 2 deskew delays\r
993                                 SCSI_ClearPin(SCSI_Out_SEL);\r
994 \r
995                                 // Prepare for the initial IDENTIFY message.\r
996                                 SCSI_Out_Ctl_Write(0);\r
997                                 scsiEnterPhase(MESSAGE_IN);\r
998 \r
999                                 // Send identify command\r
1000                                 scsiWriteByte(0x80);\r
1001 \r
1002                                 scsiEnterPhase(scsiDev.phase);\r
1003                                 reconnected = 1;\r
1004                         }\r
1005                         else\r
1006                         {\r
1007                                 // reselect timeout.\r
1008                                 SCSI_Out_Ctl_Write(0);\r
1009                                 SCSI_ClearPin(SCSI_Out_SEL);\r
1010                                 SCSI_CTL_PHASE_Write(0);\r
1011                                 ledOff();\r
1012                         }\r
1013                 }\r
1014         }\r
1015         return reconnected;\r
1016 }\r
1017 \r
1018 #pragma GCC pop_options\r