2 Copyright (c) 2006, Intel Corporation
3 All rights reserved. This program and the accompanying materials
4 are licensed and made available under the terms and conditions of the BSD License
5 which accompanies this distribution. The full text of the license may be found at
6 http://opensource.org/licenses/bsd-license.php
8 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
9 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11 Module Name: AtapiPassThru.h
19 #include <IndustryStandard/pci22.h>
24 #define bit(a) 1 << (a)
26 #define MAX_TARGET_ID 4
32 UINT16 Command
; /* when write */
33 UINT16 Status
; /* when read */
37 UINT16 Error
; /* when read */
38 UINT16 Feature
; /* when write */
39 } IDE_ERROR_OR_FEATURE
;
42 UINT16 AltStatus
; /* when read */
43 UINT16 DeviceControl
; /* when write */
44 } IDE_AltStatus_OR_DeviceControl
;
51 IDE_ERROR_OR_FEATURE Reg1
;
57 IDE_CMD_OR_STATUS Reg
;
59 IDE_AltStatus_OR_DeviceControl Alt
;
65 #define ATAPI_SCSI_PASS_THRU_DEV_SIGNATURE EFI_SIGNATURE_32 ('a', 's', 'p', 't')
71 EFI_SCSI_PASS_THRU_PROTOCOL ScsiPassThru
;
72 EFI_SCSI_PASS_THRU_MODE ScsiPassThruMode
;
73 EFI_PCI_IO_PROTOCOL
*PciIo
;
76 // Local Data goes here
78 IDE_BASE_REGISTERS
*IoPort
;
80 CHAR16 ControllerName
[100];
81 CHAR16 ChannelName
[100];
83 UINT32 LatestTargetId
;
86 } ATAPI_SCSI_PASS_THRU_DEV
;
88 #define ATAPI_SCSI_PASS_THRU_DEV_FROM_THIS(a) \
90 ATAPI_SCSI_PASS_THRU_DEV, \
92 ATAPI_SCSI_PASS_THRU_DEV_SIGNATURE \
98 extern EFI_DRIVER_BINDING_PROTOCOL gAtapiScsiPassThruDriverBinding
;
99 extern EFI_COMPONENT_NAME_PROTOCOL gAtapiScsiPassThruComponentName
;
102 // ATAPI Command op code
104 #define OP_INQUIRY 0x12
105 #define OP_LOAD_UNLOAD_CD 0xa6
106 #define OP_MECHANISM_STATUS 0xbd
107 #define OP_MODE_SELECT_10 0x55
108 #define OP_MODE_SENSE_10 0x5a
109 #define OP_PAUSE_RESUME 0x4b
110 #define OP_PLAY_AUDIO_10 0x45
111 #define OP_PLAY_AUDIO_MSF 0x47
112 #define OP_PLAY_CD 0xbc
113 #define OP_PLAY_CD_MSF 0xb4
114 #define OP_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
115 #define OP_READ_10 0x28
116 #define OP_READ_12 0xa8
117 #define OP_READ_CAPACITY 0x25
118 #define OP_READ_CD 0xbe
119 #define OP_READ_CD_MSF 0xb9
120 #define OP_READ_HEADER 0x44
121 #define OP_READ_SUB_CHANNEL 0x42
122 #define OP_READ_TOC 0x43
123 #define OP_REQUEST_SENSE 0x03
125 #define OP_SEEK_10 0x2b
126 #define OP_SET_CD_SPEED 0xbb
127 #define OP_STOPPLAY_SCAN 0x4e
128 #define OP_START_STOP_UNIT 0x1b
129 #define OP_TEST_UNIT_READY 0x00
131 #define OP_FORMAT_UNIT 0x04
132 #define OP_READ_FORMAT_CAPACITIES 0x23
133 #define OP_VERIFY 0x2f
134 #define OP_WRITE_10 0x2a
135 #define OP_WRITE_12 0xaa
136 #define OP_WRITE_AND_VERIFY 0x2e
141 #define ATAPI_SOFT_RESET_CMD 0x08
152 DATA_DIRECTION Direction
;
155 #define MAX_CHANNEL 2
157 #define ValidCdbLength(Len) ((Len) == 6 || (Len) == 10 || (Len) == 12) ? 1 : 0
160 // IDE registers bit definitions
162 // ATA Err Reg bitmap
164 #define BBK_ERR bit (7) ///< Bad block detected
165 #define UNC_ERR bit (6) ///< Uncorrectable Data
166 #define MC_ERR bit (5) ///< Media Change
167 #define IDNF_ERR bit (4) ///< ID Not Found
168 #define MCR_ERR bit (3) ///< Media Change Requested
169 #define ABRT_ERR bit (2) ///< Aborted Command
170 #define TK0NF_ERR bit (1) ///< Track 0 Not Found
171 #define AMNF_ERR bit (0) ///< Address Mark Not Found
174 // ATAPI Err Reg bitmap
176 #define SENSE_KEY_ERR (bit (7) | bit (6) | bit (5) | bit (4))
177 #define EOM_ERR bit (1) ///< End of Media Detected
178 #define ILI_ERR bit (0) ///< Illegal Length Indication
183 #define LBA_MODE bit (6)
198 #define BSY bit (7) ///< Controller Busy
199 #define DRDY bit (6) ///< Drive Ready
200 #define DWF bit (5) ///< Drive Write Fault
201 #define DSC bit (4) ///< Disk Seek Complete
202 #define DRQ bit (3) ///< Data Request
203 #define CORR bit (2) ///< Corrected Data
204 #define IDX bit (1) ///< Index
205 #define ERR bit (0) ///< Error
206 #define CHECK bit (0) ///< Check bit for ATAPI Status Reg
209 // Device Control Reg
211 #define SRST bit (2) ///< Software Reset
212 #define IEN_L bit (1) ///< Interrupt Enable
215 // ATAPI Feature Register
217 #define OVERLAP bit (1)
221 // ATAPI Interrupt Reason Reson Reg (ATA Sector Count Register)
223 #define RELEASE bit (2)
227 #define PACKET_CMD 0xA0
229 #define DEFAULT_CMD (0xa0)
231 // default content of device control register, disable INT
233 #define DEFAULT_CTL (0x0a)
234 #define MAX_ATAPI_BYTE_COUNT (0xfffe)
237 // function prototype
240 AtapiScsiPassThruDriverEntryPoint
245 @todo Add function description
246 @todo ImageHandle - add argument description
247 @todo SystemTable - add argument description
248 @todo add return values
252 AtapiScsiPassThruDriverEntryPoint (
253 IN EFI_HANDLE ImageHandle
,
254 IN EFI_SYSTEM_TABLE
*SystemTable
259 RegisterAtapiScsiPassThru
265 @todo Add function description
266 @todo This add argument description
267 @todo Controller add argument description
268 @todo PciIo add argument description
269 @todo add return values
272 RegisterAtapiScsiPassThru (
273 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
274 IN EFI_HANDLE Controller
,
275 IN EFI_PCI_IO_PROTOCOL
*PciIo
280 AtapiScsiPassThruFunction
288 @todo Add function description
289 @todo This - add argument description
290 @todo Target - add argument description
291 @todo Lun - add argument description
292 @todo Packet - add argument description
293 @todo Event - add argument description
294 @todo add return values
298 AtapiScsiPassThruFunction (
299 IN EFI_SCSI_PASS_THRU_PROTOCOL
*This
,
302 IN OUT EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
303 IN EFI_EVENT Event OPTIONAL
308 AtapiScsiPassThruGetNextDevice
310 TODO: Add function description
312 @param This TODO: add argument description
313 @param Target TODO: add argument description
314 @param Lun TODO: add argument description
316 TODO: add return values
321 AtapiScsiPassThruGetNextDevice (
322 IN EFI_SCSI_PASS_THRU_PROTOCOL
*This
,
323 IN OUT UINT32
*Target
,
329 AtapiScsiPassThruBuildDevicePath
331 TODO: Add function description
333 @param This TODO: add argument description
334 @param Target TODO: add argument description
335 @param Lun TODO: add argument description
336 @param DevicePath TODO: add argument description
338 TODO: add return values
343 AtapiScsiPassThruBuildDevicePath (
344 IN EFI_SCSI_PASS_THRU_PROTOCOL
*This
,
347 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
352 AtapiScsiPassThruGetTargetLun
354 TODO: Add function description
356 @param This TODO: add argument description
357 @param DevicePath TODO: add argument description
358 @param Target TODO: add argument description
359 @param Lun TODO: add argument description
361 TODO: add return values
366 AtapiScsiPassThruGetTargetLun (
367 IN EFI_SCSI_PASS_THRU_PROTOCOL
*This
,
368 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
375 AtapiScsiPassThruResetChannel
377 TODO: Add function description
379 @param This TODO: add argument description
381 TODO: add return values
386 AtapiScsiPassThruResetChannel (
387 IN EFI_SCSI_PASS_THRU_PROTOCOL
*This
392 AtapiScsiPassThruResetTarget
394 TODO: Add function description
396 @param This TODO: add argument description
397 @param Target TODO: add argument description
398 @param Lun TODO: add argument description
400 TODO: add return values
405 AtapiScsiPassThruResetTarget (
406 IN EFI_SCSI_PASS_THRU_PROTOCOL
*This
,
413 CheckSCSIRequestPacket
415 TODO: Add function description
417 @param Packet TODO: add argument description
419 TODO: add return values
423 CheckSCSIRequestPacket (
424 EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
429 SubmitBlockingIoCommand
431 TODO: Add function description
433 @param AtapiScsiPrivate TODO: add argument description
434 @param Target TODO: add argument description
435 @param Packet TODO: add argument description
437 TODO: add return values
441 SubmitBlockingIoCommand (
442 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
444 EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
451 TODO: Add function description
453 @param Packet - TODO: add argument description
455 @return TODO: add return values
460 EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
467 TODO: Add function description
469 @param AtapiScsiPrivate TODO: add argument description
470 @param Target TODO: add argument description
471 @param Timeout TODO: add argument description
472 @param SenseData TODO: add argument description
473 @param SenseDataLength TODO: add argument description
475 TODO: add return values
479 RequestSenseCommand (
480 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
484 UINT8
*SenseDataLength
491 TODO: Add function description
493 @param AtapiScsiPrivate TODO: add argument description
494 @param Target TODO: add argument description
495 @param PacketCommand TODO: add argument description
496 @param Buffer TODO: add argument description
497 @param ByteCount TODO: add argument description
498 @param Direction TODO: add argument description
499 @param TimeOutInMicroSeconds TODO: add argument description
501 TODO: add return values
506 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
508 UINT8
*PacketCommand
,
511 DATA_DIRECTION Direction
,
512 UINT64 TimeOutInMicroSeconds
520 TODO: Add function description
522 @param PciIo TODO: add argument description
523 @param Port TODO: add argument description
525 TODO: add return values
530 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
539 TODO: Add function description
541 @param PciIo TODO: add argument description
542 @param Port TODO: add argument description
544 TODO: add return values
549 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
558 TODO: Add function description
560 @param PciIo TODO: add argument description
561 @param Port TODO: add argument description
562 @param Data TODO: add argument description
564 TODO: add return values
569 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
579 TODO: Add function description
581 @param PciIo TODO: add argument description
582 @param Port TODO: add argument description
583 @param Data TODO: add argument description
585 TODO: add return values
590 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
599 TODO: Add function description
601 @param AtapiScsiPrivate TODO: add argument description
602 @param TimeOutInMicroSeconds TODO: add argument description
604 TODO: add return values
609 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
610 UINT64 TimeOutInMicroSeconds
617 TODO: Add function description
619 @param AtapiScsiPrivate TODO: add argument description
620 @param TimeOutInMicroSeconds TODO: add argument description
622 TODO: add return values
627 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
628 UINT64 TimeOutInMicroSeconds
635 TODO: Add function description
637 @param AtapiScsiPrivate TODO: add argument description
638 @param TimeOutInMicroSeconds TODO: add argument description
640 TODO: add return values
645 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
646 UINT64 TimeOutInMicroSeconds
653 TODO: Add function description
655 @param AtapiScsiPrivate TODO: add argument description
656 @param TimeOutInMicroSeconds TODO: add argument description
658 TODO: add return values
663 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
664 UINT64 TimeOutInMicroSeconds
669 TODO: Add function description
671 @param AtapiScsiPrivate TODO: add argument description
672 @param TimeoutInMicroSeconds TODO: add argument description
674 TODO: add return values
678 StatusWaitForBSYClear (
679 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
680 UINT64 TimeoutInMicroSeconds
685 TODO: Add function description
687 @param AtapiScsiPrivate TODO: add argument description
688 @param TimeoutInMicroSeconds TODO: add argument description
690 TODO: add return values
694 AltStatusWaitForBSYClear (
695 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
696 UINT64 TimeoutInMicroSeconds
701 TODO: Add function description
703 @param AtapiScsiPrivate TODO: add argument description
704 @param TimeoutInMicroSeconds TODO: add argument description
706 TODO: add return values
711 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
712 UINT64 TimeoutInMicroSeconds
717 TODO: Add function description
719 @param AtapiScsiPrivate TODO: add argument description
720 @param TimeoutInMicroSeconds TODO: add argument description
722 TODO: add return values
727 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
728 UINT64 TimeoutInMicroSeconds
733 TODO: Add function description
735 @param AtapiScsiPrivate TODO: add argument description
736 @param Buffer TODO: add argument description
737 @param ByteCount TODO: add argument description
738 @param Direction TODO: add argument description
739 @param TimeOutInMicroSeconds TODO: add argument description
741 TODO: add return values
745 AtapiPassThruPioReadWriteData (
746 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate
,
749 DATA_DIRECTION Direction
,
750 UINT64 TimeOutInMicroSeconds
755 TODO: Add function description
757 @param AtapiScsiPrivate TODO: add argument description
759 TODO: add return values
763 AtapiPassThruCheckErrorStatus (
764 ATAPI_SCSI_PASS_THRU_DEV
*AtapiScsiPrivate