#![allow(dead_code)]
use modular_bitfield_msb::prelude::*;
use crate::{
command::bitfield_bound_check,
data_wrapper::{AnyType, VecBufferWrapper},
result_data::ResultData,
Command, DataDirection, Scsi,
};
#[derive(Clone, Debug)]
pub struct WriteCommand<'a> {
interface: &'a Scsi,
control: u8,
group_number: u8,
write_protect: u8,
disable_page_out: bool,
force_unit_access: bool,
logical_block_address: u64,
expected_initial_logical_block_reference_tag: u32,
expected_logical_block_application_tag: u16,
logical_block_application_tag_mask: u16,
dld_0: bool,
dld_1: bool,
dld_2: bool,
logical_block_size: u32,
data_buffer: Vec<u8>,
}
impl<'a> WriteCommand<'a> {
fn new(interface: &'a Scsi) -> Self {
Self {
interface,
control: 0,
group_number: 0,
write_protect: 0,
disable_page_out: false,
force_unit_access: false,
logical_block_address: 0,
expected_initial_logical_block_reference_tag: 0,
expected_logical_block_application_tag: 0,
logical_block_application_tag_mask: 0,
dld_0: false,
dld_1: false,
dld_2: false,
logical_block_size: 512,
data_buffer: vec![],
}
}
pub fn group_number(&mut self, value: u8) -> &mut Self {
self.group_number = value;
self
}
pub fn write_protect(&mut self, value: u8) -> &mut Self {
self.write_protect = value;
self
}
pub fn disable_page_out(&mut self, value: bool) -> &mut Self {
self.disable_page_out = value;
self
}
pub fn force_unit_access(&mut self, value: bool) -> &mut Self {
self.force_unit_access = value;
self
}
pub fn logical_block_address(&mut self, value: u64) -> &mut Self {
self.logical_block_address = value;
self
}
pub fn expected_initial_logical_block_reference_tag(&mut self, value: u32) -> &mut Self {
self.expected_initial_logical_block_reference_tag = value;
self
}
pub fn expected_logical_block_application_tag(&mut self, value: u16) -> &mut Self {
self.expected_logical_block_application_tag = value;
self
}
pub fn logical_block_application_tag_mask(&mut self, value: u16) -> &mut Self {
self.logical_block_application_tag_mask = value;
self
}
pub fn dld_0(&mut self, value: bool) -> &mut Self {
self.dld_0 = value;
self
}
pub fn dld_1(&mut self, value: bool) -> &mut Self {
self.dld_1 = value;
self
}
pub fn dld_2(&mut self, value: bool) -> &mut Self {
self.dld_2 = value;
self
}
pub fn logical_block_size(&mut self, value: u32) -> &mut Self {
self.logical_block_size = value;
self
}
pub fn control(&mut self, value: u8) -> &mut Self {
self.control = value;
self
}
pub fn parameter(&mut self, value: &[u8]) -> &mut Self {
self.data_buffer.clear();
self.data_buffer.extend_from_slice(value);
self
}
fn error_check(
&self,
group_number_bits: u32,
logical_block_address_bits: u32,
transfer_length_bits: u32,
allow_dld: bool,
expect_tag: bool,
) -> crate::Result<()> {
bitfield_bound_check!(self.group_number, group_number_bits, "group number")?;
bitfield_bound_check!(self.write_protect, 3, "verify protect")?;
bitfield_bound_check!(
self.logical_block_address,
logical_block_address_bits,
"logical block address"
)?;
if self.data_buffer.len() % self.logical_block_size as usize != 0 {
return Err(crate::Error::BadArgument(format!(
"parameter length should be a multiple of logical block size, which is {}.",
self.logical_block_size
)));
}
if (self.data_buffer.len() / self.logical_block_size as usize)
.wrapping_shr(transfer_length_bits)
!= 0
{
return Err(crate::Error::ArgumentOutOfBounds(format!(
"parameter length is out of bounds. The maximum possible value is {}, but {} was provided.",
1u128.wrapping_shl(transfer_length_bits) * self.logical_block_size as u128,
self.data_buffer.len()
)));
}
if !allow_dld && (self.dld_0 || self.dld_1 || self.dld_2) {
return Err(crate::Error::BadArgument(
"DLDs are not allowed here".to_owned(),
));
}
if !expect_tag
&& (self.expected_initial_logical_block_reference_tag != 0
|| self.expected_logical_block_application_tag != 0
|| self.logical_block_application_tag_mask != 0)
{
return Err(crate::Error::BadArgument(
"expected tags and mask are not allowed here".to_owned(),
));
}
Ok(())
}
pub fn issue_10(&mut self) -> crate::Result<()> {
self.error_check(5, 32, 16, false, false)?;
let command_buffer = CommandBuffer10::new()
.with_operation_code(OPERATION_CODE_10)
.with_write_protect(self.write_protect)
.with_disable_page_out(self.disable_page_out.into())
.with_force_unit_access(self.force_unit_access.into())
.with_logical_block_address(self.logical_block_address as u32)
.with_group_number(self.group_number)
.with_transfer_length(
(self.data_buffer.len() / self.logical_block_size as usize) as u16,
)
.with_control(self.control);
self.interface.issue(&ThisCommand {
command_buffer,
data_buffer: self.data_buffer.clone().into(),
})
}
pub fn issue_12(&mut self) -> crate::Result<()> {
self.error_check(5, 32, 32, false, false)?;
let command_buffer = CommandBuffer12::new()
.with_operation_code(OPERATION_CODE_12)
.with_write_protect(self.write_protect)
.with_disable_page_out(self.disable_page_out.into())
.with_force_unit_access(self.force_unit_access.into())
.with_logical_block_address(self.logical_block_address as u32)
.with_transfer_length(
(self.data_buffer.len() / self.logical_block_size as usize) as u32,
)
.with_group_number(self.group_number)
.with_control(self.control);
self.interface.issue(&ThisCommand {
command_buffer,
data_buffer: self.data_buffer.clone().into(),
})
}
pub fn issue_16(&mut self) -> crate::Result<()> {
self.error_check(6, 64, 32, true, false)?;
let command_buffer = CommandBuffer16::new()
.with_operation_code(OPERATION_CODE_16)
.with_write_protect(self.write_protect)
.with_disable_page_out(self.disable_page_out.into())
.with_force_unit_access(self.force_unit_access.into())
.with_logical_block_address(self.logical_block_address)
.with_transfer_length(
(self.data_buffer.len() / self.logical_block_size as usize) as u32,
)
.with_dld_0(self.dld_0.into())
.with_dld_1(self.dld_1.into())
.with_dld_2(self.dld_2.into())
.with_group_number(self.group_number)
.with_control(self.control);
self.interface.issue(&ThisCommand {
command_buffer,
data_buffer: self.data_buffer.clone().into(),
})
}
pub fn issue_32(&mut self) -> crate::Result<()> {
self.error_check(5, 64, 32, false, true)?;
let command_buffer = CommandBuffer32::new()
.with_operation_code(OPERATION_CODE_32)
.with_control(self.control)
.with_group_number(self.group_number)
.with_additional_cdb_length(0x18)
.with_service_action(SERVICE_ACTION_32)
.with_write_protect(self.write_protect)
.with_disable_page_out(self.disable_page_out.into())
.with_force_unit_access(self.force_unit_access.into())
.with_logical_block_address(self.logical_block_address)
.with_expected_initial_logical_block_reference_tag(
self.expected_initial_logical_block_reference_tag,
)
.with_expected_logical_block_application_tag(
self.expected_logical_block_application_tag,
)
.with_logical_block_application_tag_mask(self.logical_block_application_tag_mask)
.with_transfer_length(
(self.data_buffer.len() / self.logical_block_size as usize) as u32,
);
self.interface.issue(&ThisCommand {
command_buffer,
data_buffer: self.data_buffer.clone().into(),
})
}
}
impl Scsi {
pub fn write(&self) -> WriteCommand<'_> {
WriteCommand::new(self)
}
}
const OPERATION_CODE_10: u8 = 0x2A;
const OPERATION_CODE_12: u8 = 0xAA;
const OPERATION_CODE_16: u8 = 0x8A;
const OPERATION_CODE_32: u8 = 0x7F;
const SERVICE_ACTION_32: u16 = 0x000B;
#[bitfield]
#[derive(Clone, Copy)]
struct CommandBuffer10 {
operation_code: B8,
write_protect: B3,
disable_page_out: B1,
force_unit_access: B1,
reserved_0: B1,
obsolete: B2,
logical_block_address: B32,
reserved_1: B3,
group_number: B5,
transfer_length: B16,
control: B8,
}
#[bitfield]
#[derive(Clone, Copy)]
struct CommandBuffer12 {
operation_code: B8,
write_protect: B3,
disable_page_out: B1,
force_unit_access: B1,
reserved_0: B1,
obsolete: B2,
logical_block_address: B32,
transfer_length: B32,
reserved_1: B3,
group_number: B5,
control: B8,
}
#[bitfield]
#[derive(Clone, Copy)]
struct CommandBuffer16 {
operation_code: B8,
write_protect: B3,
disable_page_out: B1,
force_unit_access: B1,
reserved: B1,
obsolete: B1,
dld_2: B1,
logical_block_address: B64,
transfer_length: B32,
dld_1: B1,
dld_0: B1,
group_number: B6,
control: B8,
}
#[bitfield]
#[derive(Clone, Copy)]
struct CommandBuffer32 {
operation_code: B8,
control: B8,
reserved_0: B32,
reserved_1: B3,
group_number: B5,
additional_cdb_length: B8,
service_action: B16,
write_protect: B3,
disable_page_out: B1,
force_unit_access: B1,
reserved_2: B1,
obsolete: B1,
reserved_3: B1,
reserved_4: B8,
logical_block_address: B64,
expected_initial_logical_block_reference_tag: B32,
expected_logical_block_application_tag: B16,
logical_block_application_tag_mask: B16,
transfer_length: B32,
}
struct ThisCommand<C> {
command_buffer: C,
data_buffer: VecBufferWrapper,
}
impl<C: Copy> Command for ThisCommand<C> {
type CommandBuffer = C;
type DataBuffer = AnyType;
type DataBufferWrapper = VecBufferWrapper;
type ReturnType = crate::Result<()>;
fn direction(&self) -> DataDirection {
DataDirection::ToDevice
}
fn command(&self) -> Self::CommandBuffer {
self.command_buffer
}
fn data(&self) -> Self::DataBufferWrapper {
self.data_buffer.clone()
}
fn data_size(&self) -> u32 {
self.data_buffer.len() as u32
}
fn process_result(&self, result: ResultData<Self::DataBufferWrapper>) -> Self::ReturnType {
result.check_ioctl_error()?;
result.check_common_error()?;
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::mem::size_of;
const COMMAND_LENGTH_10: usize = 10;
const COMMAND_LENGTH_12: usize = 12;
const COMMAND_LENGTH_16: usize = 16;
const COMMAND_LENGTH_32: usize = 32;
#[test]
fn layout_test() {
assert_eq!(
size_of::<CommandBuffer10>(),
COMMAND_LENGTH_10,
concat!("Size of: ", stringify!(CommandBuffer10))
);
assert_eq!(
size_of::<CommandBuffer12>(),
COMMAND_LENGTH_12,
concat!("Size of: ", stringify!(CommandBuffer12))
);
assert_eq!(
size_of::<CommandBuffer16>(),
COMMAND_LENGTH_16,
concat!("Size of: ", stringify!(CommandBuffer16))
);
assert_eq!(
size_of::<CommandBuffer32>(),
COMMAND_LENGTH_32,
concat!("Size of: ", stringify!(CommandBuffer32))
);
}
}