-
-
Notifications
You must be signed in to change notification settings - Fork 180
[STALE] add SCSI Protocol support #1155
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Draft
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
dcfb758
[SCSI] add SCSI Protocol as preliminary supported.
sky5454 76df1ed
[SCSI] build pass.
sky5454 50633de
[SCSI] use DevicePath replace DevicePathProtocol in FFI.
sky5454 472e372
[SCSI] code format.
sky5454 35dd74f
[SCSI][uefi-raw] add docs about raw packet `ScsiIoScsiRequestPacket` ...
sky5454 08a2292
[SCSI] FFI for scsi request packet; and docs.
sky5454 b36ba06
[SCSI] use newtype_enum instead of bitflags.
sky5454 ea3e4b1
[SCSI] refactor and add test. fixed ExtScsiPassThruProtocol::mode; no...
sky5454 f188178
Merge branch 'rust-osdev:main' into main
sky5454 c9777f3
[scsi_io] add supported for `EFI SCSI I/O Protocol`.
sky5454 d443ac8
[scsi_io] add supported for `EFI SCSI I/O Protocol`.
sky5454 b06d766
Merge remote-tracking branch 'origin/main'
sky5454 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
4 changes: 4 additions & 0 deletions
uefi-raw/CHANGELOG.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,4 +16,5 @@ pub mod memory_protection; | |
| pub mod misc; | ||
| pub mod network; | ||
| pub mod rng; | ||
| pub mod scsi; | ||
| pub mod shell_params; | ||
160 changes: 160 additions & 0 deletions
uefi-raw/src/protocol/scsi.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| use core::ffi::c_void; | ||
|
|
||
| use crate::{guid, Event, Guid, Status}; | ||
|
|
||
| /// TODO: use #define TARGET_MAX_BYTES 0x10, the limit of target. | ||
| #[allow(unused)] | ||
| const TARGET_MAX_BYTES: u32 = 0x10; | ||
|
|
||
| newtype_enum! { | ||
| /// DataDirection | ||
| #[derive(Default)] | ||
| pub enum DataDirection: u8 => { | ||
| READ = 0, | ||
| WRITE = 1, | ||
| BIDIRECTIONAL = 2, | ||
| } | ||
| } | ||
|
|
||
| newtype_enum! { | ||
| /// HostAdapterStatus | ||
| #[derive(Default)] | ||
| pub enum HostAdapterStatus: u8 => { | ||
|
|
||
| /// EFI_SCSI_IO_STATUS_HOST_ADAPTER_OK | ||
| OK = 0x00, | ||
| TIMEOUT_COMMAND = 0x09, | ||
| TIMEOUT = 0x0b, | ||
| MESSAGE_REJECT = 0x0d, | ||
| BUS_RESET = 0x0e, | ||
| PARITY_ERROR = 0x0f, | ||
| REQUEST_SENSE_FAILED = 0x10, | ||
| SELECTION_TIMEOUT = 0x11, | ||
| DATA_OVERRUN_UNDERRUN = 0x12, | ||
| BUS_FREE = 0x13, | ||
| PHASE_ERROR = 0x14, | ||
| OTHER = 0x7f, | ||
| } | ||
| } | ||
|
|
||
| newtype_enum! { | ||
| /// TargetStatus | ||
| #[derive(Default)] | ||
| pub enum TargetStatus: u8 => { | ||
| /// EFI_SCSI_IO_STATUS_TARGET_GOOD | ||
| GOOD = 0x00, | ||
| CHECK_CONDITION = 0x02, | ||
| CONDITION_MET = 0x04, | ||
| BUSY = 0x08, | ||
| INTERMEDIATE = 0x10, | ||
| INTERMEDIATE_CONDITION_MET = 0x14, | ||
| RESERVATION_CONFLICT = 0x18, | ||
| COMMAND_TERMINATED = 0x22, | ||
| QUEUE_FULL = 0x28, | ||
| } | ||
| } | ||
|
|
||
| /// EFI_SCSI_IO_SCSI_REQUEST_PACKET | ||
| #[derive(Debug, Copy, Clone)] | ||
| #[repr(C)] | ||
| pub struct ScsiIoScsiRequestPacket { | ||
| /// Timeout: The timeout, in 100 ns units, to use for the execution of this SCSI Request Packet. | ||
| /// A Timeout value of 0 means that this function will wait indefinitely for the SCSI Request Packet to execute. | ||
| /// If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout . | ||
| pub timeout: u64, | ||
|
|
||
| /// []DataBuffer: A pointer to the data buffer to transfer from or to the SCSI device. | ||
| /// InDataBuffer: A pointer to the data buffer to transfer between the SCSI controller and the SCSI device for SCSI READ command. | ||
| /// For all SCSI WRITE Commands this must point to NULL . | ||
| pub in_data_buffer: *mut c_void, | ||
| /// OutDataBuffer: A pointer to the data buffer to transfer between the SCSI controller and the SCSI device for SCSI WRITE command. | ||
| /// For all SCSI READ commands this field must point to NULL . | ||
| pub out_data_buffer: *mut c_void, | ||
| /// SenseData: A pointer to the sense data that was generated by the execution of the SCSI Request Packet. | ||
| pub sense_data: *mut c_void, | ||
| /// Cdb: A pointer to buffer that contains the Command Data Block to send to the SCSI device. | ||
| pub cdb: *mut c_void, | ||
|
|
||
| /// InTransferLength: On Input, the size, in bytes, of InDataBuffer . | ||
| /// On output, the number of bytes transferred between the SCSI controller and the SCSI device. | ||
| /// If InTransferLength is larger than the SCSI controller can handle, no data will be transferred, | ||
| /// InTransferLength will be updated to contain the number of bytes that the SCSI controller is able to transfer, and EFI_BAD_BUFFER_SIZE will be returned. | ||
| pub in_transfer_length: u32, | ||
| /// OutTransferLength: On Input, the size, in bytes of OutDataBuffer . | ||
| /// On Output, the Number of bytes transferred between SCSI Controller and the SCSI device. | ||
| /// If OutTransferLength is larger than the SCSI controller can handle, no data will be transferred, | ||
| /// OutTransferLength will be updated to contain the number of bytes that the SCSI controller is able to transfer, and EFI_BAD_BUFFER_SIZE will be returned. | ||
| pub out_transfer_length: u32, | ||
|
|
||
| /// CdbLength: The length, in bytes, of the buffer Cdb . | ||
| /// The standard values are 6, 10, 12, and 16, but other values are possible if a variable length CDB is used. | ||
| pub cdb_length: u8, | ||
| /// DataDirection: The direction of the data transfer. 0 for reads, 1 for writes. | ||
| /// A value of 2 is Reserved for Bi-Directional SCSI commands. For example XDREADWRITE. | ||
| /// All other values are reserved, and must not be used. | ||
| pub data_direction: DataDirection, | ||
| /// HostAdapterStatus: The status of the SCSI Host Controller that produces the SCSI bus | ||
| /// where the SCSI device attached when the SCSI Request Packet was executed on the SCSI Controller. | ||
| pub host_adapter_status: HostAdapterStatus, | ||
| /// TargetStatus: The status returned by the SCSI device when the SCSI Request Packet was executed. | ||
| pub target_status: TargetStatus, | ||
| /// SenseDataLength: On input, the length in bytes of the SenseData buffer. | ||
| /// On output, the number of bytes written to the SenseData buffer. | ||
| pub sense_data_length: u8, | ||
| } | ||
|
|
||
| newtype_enum! { | ||
| /// DeviceType | ||
| /// Defined in the SCSI Primary Commands standard (e.g., SPC-4) | ||
| #[derive(Default)] | ||
| pub enum DeviceType: u8 => { | ||
| DISK = 0x00, // Disk device | ||
| TAPE = 0x01, // Tape device | ||
| PRINTER = 0x02,// Printer | ||
| PROCESSOR = 0x03,// Processor | ||
| WORM = 0x04,// Write-once read-multiple | ||
| CDROM = 0x05,// CD or DVD device | ||
| SCANNER = 0x06,// Scanner device | ||
| OPTICAL = 0x07,// Optical memory device | ||
| MEDIUMCHANGER = 0x08,// Medium Changer device | ||
| COMMUNICATION = 0x09,// Communications device | ||
|
|
||
|
|
||
| MFI_A = 0x0A, // Obsolete | ||
| MFI_B = 0x0B, // Obsolete | ||
| MFI_RAID = 0x0C, // Storage array controller | ||
| MFI_SES = 0x0D, // Enclosure services device | ||
| MFI_RBC = 0x0E, // Simplified direct-access | ||
| MFI_OCRW = 0x0F, // Optical card reader/ | ||
| MFI_BRIDGE = 0x10, // Bridge Controller | ||
| MFI_OSD = 0x11, // Object-based Storage | ||
|
|
||
| RESERVED_LOW = 0x12, // Reserved (low) | ||
| RESERVED_HIGH = 0x1E, // Reserved (high) | ||
| UNKNOWN = 0x1F, // Unknown no device type | ||
| } | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
| #[repr(C)] | ||
| pub struct ScsiIoProtocol { | ||
| //TODO: return deviceType | ||
| pub get_device_type: | ||
| unsafe extern "efiapi" fn(this: *const Self, device_type: *mut DeviceType) -> Status, | ||
| //TODO: raw pointer need to fixed, see uefi-rs service code like pointer *u8 | ||
| pub get_device_location: | ||
| unsafe extern "efiapi" fn(this: *const Self, target: *mut *mut u8, lun: *mut u64) -> Status, | ||
| pub reset_bus: unsafe extern "efiapi" fn(this: *mut Self) -> Status, | ||
| pub reset_device: unsafe extern "efiapi" fn(this: *mut Self) -> Status, | ||
| pub execute_scsi_command: unsafe extern "efiapi" fn( | ||
| this: *const Self, | ||
| packet: *mut ScsiIoScsiRequestPacket, | ||
| event: Event, | ||
| ) -> Status, | ||
| pub io_align: u32, | ||
| } | ||
|
|
||
| /// 15.4. EFI SCSI I/O Protocol | ||
| impl ScsiIoProtocol { | ||
| pub const GUID: Guid = guid!("932f47e6-2362-4002-803e-3cd54b138f85"); | ||
| } |
132 changes: 132 additions & 0 deletions
uefi-test-runner/examples/scsi.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| // ANCHOR: all | ||
| // ANCHOR: features | ||
| #![no_main] | ||
| #![no_std] | ||
| // ANCHOR_END: features | ||
|
|
||
| extern crate alloc; | ||
|
|
||
| use alloc::vec; | ||
| use core::mem; | ||
|
|
||
| use log::info; | ||
|
|
||
| // ANCHOR: use | ||
| use uefi::prelude::*; | ||
| use uefi::proto::scsi::{ScsiIo, ScsiRequestPacket}; | ||
|
|
||
| // ANCHOR_END: use | ||
|
|
||
| // ANCHOR: entry | ||
| #[entry] | ||
| fn main(image_handle: Handle, mut system_table: SystemTable<Boot>) -> Status { | ||
| // ANCHOR_END: entry | ||
| // ANCHOR: services | ||
| uefi::helpers::init(&mut system_table).unwrap(); | ||
| let boot_services = system_table.boot_services(); | ||
| // ANCHOR_END: services | ||
|
|
||
| // ANCHOR: params, all api OK, but memory panic when return, maybe the vec. | ||
| test_scsi_io(boot_services); | ||
| // ANCHOR_END: params, panic at uefi/src/allocator.rs#L130 (*boot_services()).free_pool(ptr).unwrap(); | ||
|
|
||
|
|
||
| // ANCHOR: stall | ||
| boot_services.stall(10_000_000); | ||
| // ANCHOR_END: stall | ||
|
|
||
| // ANCHOR: return | ||
| Status::SUCCESS | ||
| } | ||
| // ANCHOR_END: return | ||
|
|
||
| pub fn test_scsi_io(bt: &BootServices) { | ||
| info!("Running loaded Scsi protocol test"); | ||
|
|
||
| let handle = bt | ||
| .get_handle_for_protocol::<ScsiIo>() | ||
| .expect("Failed to get handles for `ScsiIo` protocol"); | ||
|
|
||
| let mut scsi_protocol = bt | ||
| .open_protocol_exclusive::<ScsiIo>(handle) | ||
| .expect("Founded ScsiIo Protocol but open failed"); | ||
|
|
||
| // value efi_reset_fn is the type of ResetSystemFn, a function pointer | ||
|
|
||
| let result = scsi_protocol.get_device_type(); | ||
| info!("SCSI_IO Protocol get device_type: {:?}", result); | ||
|
|
||
| let result = scsi_protocol.io_align(); | ||
| info!("SCSI_IO Protocol's io_align: {:?}", result); | ||
|
|
||
| let result = scsi_protocol.get_device_location(); | ||
| info!("SCSI_IO Protocol get dev location: {:?}", result); | ||
|
|
||
| let result = scsi_protocol.reset_bus(); | ||
| info!("SCSI_IO Protocol reset bus test: {:?}", result); | ||
|
|
||
| let result = scsi_protocol.reset_device(); | ||
| info!("SCSI_IO Protocol reset dev test: {:?}", result); | ||
|
|
||
| bt.stall(10_000); | ||
|
|
||
| let mut packet_tur: ScsiRequestPacket = ScsiRequestPacket::default(); | ||
| packet_tur.is_a_write_packet = false; | ||
| packet_tur.cdb = vec![0x00, 0, 0, 0, 0, 0x00]; | ||
| packet_tur.timeout = 0; | ||
| info!("packet_tur: {:?}", packet_tur); | ||
| let result = scsi_protocol.execute_scsi_command(&mut packet_tur, None); | ||
| info!("=================SCSI_IO Protocol exec scsi command [TestUnitReady] test: {:?}", result); | ||
|
|
||
| let mut packet_icmd: ScsiRequestPacket = ScsiRequestPacket::default(); | ||
| packet_icmd.is_a_write_packet = false; | ||
| packet_icmd.cdb = vec![0x12, 0x01, 0x00, 0, 0, 0x00]; | ||
| packet_icmd.data_buffer = vec![0; 96]; | ||
| packet_icmd.sense_data = vec![0; 18]; | ||
| packet_icmd.timeout = 0; | ||
| let result = scsi_protocol.execute_scsi_command(&mut packet_icmd, None); | ||
| info!("=================SCSI_IO Protocol exec scsi command [InquiryCommand] test: {:?}", result); | ||
|
|
||
| // drop(packet) | ||
| // now send Req is ok. but it seems couldn't receive Resp. | ||
| } | ||
|
|
||
| /* | ||
| // The InquiryCommand | ||
|
|
||
|
|
||
| // sense_data with UINT8*18 | ||
| /// | ||
| /// Error codes 70h and 71h sense data format | ||
| /// | ||
| typedef struct { | ||
| UINT8 Error_Code : 7; | ||
| UINT8 Valid : 1; | ||
| UINT8 Segment_Number; | ||
| UINT8 Sense_Key : 4; | ||
| UINT8 Reserved_21 : 1; | ||
| UINT8 Ili : 1; | ||
| UINT8 Reserved_22 : 2; | ||
| UINT8 Information_3_6[4]; | ||
| UINT8 Addnl_Sense_Length; ///< Additional sense length (n-7) | ||
| UINT8 Vendor_Specific_8_11[4]; | ||
| UINT8 Addnl_Sense_Code; ///< Additional sense code | ||
| UINT8 Addnl_Sense_Code_Qualifier; ///< Additional sense code qualifier | ||
| UINT8 Field_Replaceable_Unit_Code; ///< Field replaceable unit code | ||
| UINT8 Reserved_15_17[3]; | ||
| } EFI_SCSI_SENSE_DATA; | ||
|
|
||
|
|
||
|
|
||
| // in_data_buf with UINT8 * 96 | ||
| typedef struct { | ||
| UINT8 Peripheral_Type : 5; | ||
| UINT8 Peripheral_Qualifier : 3; | ||
| UINT8 DeviceType_Modifier : 7; | ||
| UINT8 Rmb : 1; | ||
| UINT8 Version; | ||
| UINT8 Response_Data_Format; | ||
| UINT8 Addnl_Length; | ||
| UINT8 Reserved_5_95[95 - 5 + 1]; | ||
| } EFI_SCSI_INQUIRY_DATA; | ||
| */ |
4 changes: 4 additions & 0 deletions
uefi/CHANGELOG.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,9 @@ | ||
| # uefi - [Unreleased] | ||
|
|
||
| ## Added | ||
|
|
||
| - Added `ScsiIo` Protocol. | ||
|
|
||
| ## Added | ||
| - Added `RuntimeServices::update_capsule`. | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.