SCSI devices. More...

#include <stdint.h>
#include <ipxe/uaccess.h>
#include <ipxe/interface.h>

Data Structures
struct	scsi_cdb_read_10
	A SCSI "READ (10)" CDB. More...

struct	scsi_cdb_read_16
	A SCSI "READ (16)" CDB. More...

struct	scsi_cdb_write_10
	A SCSI "WRITE (10)" CDB. More...

struct	scsi_cdb_write_16
	A SCSI "WRITE (16)" CDB. More...

struct	scsi_cdb_read_capacity_10
	A SCSI "READ CAPACITY (10)" CDB. More...

struct	scsi_capacity_10
	SCSI "READ CAPACITY (10)" parameter data. More...

struct	scsi_cdb_read_capacity_16
	A SCSI "READ CAPACITY (16)" CDB. More...

struct	scsi_capacity_16
	SCSI "READ CAPACITY (16)" parameter data. More...

struct	scsi_cdb_test_unit_ready
	A SCSI "TEST UNIT READY" CDB. More...

union	scsi_cdb
	A SCSI Command Data Block. More...

struct	scsi_lun
	A SCSI LUN. More...

struct	scsi_cmd
	A SCSI command information unit. More...

struct	scsi_sns_fixed
	SCSI fixed-format sense data. More...

struct	scsi_sns_descriptor
	SCSI descriptor-format sense data. More...

union	scsi_sns
	SCSI sense data. More...

struct	scsi_rsp
	A SCSI response information unit. More...

Macros
#define	SCSI_MAX_BLOCK_10 0xffffffffULL
	Maximum block for READ/WRITE (10) commands. More...

#define	SCSI_OPCODE_READ_10 0x28
	READ (10) More...

#define	SCSI_OPCODE_READ_16 0x88
	READ (16) More...

#define	SCSI_OPCODE_WRITE_10 0x2a
	WRITE (10) More...

#define	SCSI_OPCODE_WRITE_16 0x8a
	WRITE (16) More...

#define	SCSI_OPCODE_READ_CAPACITY_10 0x25
	READ CAPACITY (10) More...

#define	SCSI_OPCODE_SERVICE_ACTION_IN 0x9e
	SERVICE ACTION IN. More...

#define	SCSI_SERVICE_ACTION_READ_CAPACITY_16 0x10
	READ CAPACITY (16) More...

#define	SCSI_OPCODE_TEST_UNIT_READY 0x00
	TEST UNIT READY. More...

#define	SCSI_FL_FUA_NV 0x02
	Force unit access to NVS. More...

#define	SCSI_FL_FUA 0x08
	Force unit access. More...

#define	SCSI_FL_DPO 0x10
	Disable cache page out. More...

#define	SCSI_CDB_FORMAT
	printf() format for dumping a scsi_cdb More...

#define	SCSI_CDB_DATA(cdb)
	printf() parameters for dumping a scsi_cdb More...

#define	SCSI_LUN_FORMAT "%04x-%04x-%04x-%04x"
	printf() format for dumping a scsi_lun More...

#define	SCSI_LUN_DATA(lun)
	printf() parameters for dumping a scsi_lun More...

#define	SCSI_SENSE_CODE_MASK 0x7f
	SCSI sense response code mask. More...

#define	SCSI_SENSE_FIXED(code) ( ( (code) & 0x7e ) == 0x70 )
	Test if SCSI sense data is in fixed format. More...

#define	SCSI_SENSE_KEY_MASK 0x0f
	SCSI sense key mask. More...

#define	scsi_command_TYPE(object_type)

#define	scsi_response_TYPE(object_type) typeof ( void ( object_type, struct scsi_rsp *response ) )

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

struct scsi_cdb_read_10	__attribute__ ((packed))

int	scsi_parse_lun (const char lun_string, struct scsi_lun lun)
	Parse SCSI LUN. More...

void	scsi_parse_sense (const void data, size_t len, struct scsi_sns_descriptor sense)
	Parse SCSI sense data. More...

int	scsi_command (struct interface control, struct interface data, struct scsi_cmd *command)
	Issue SCSI command. More...

void	scsi_response (struct interface intf, struct scsi_rsp response)
	Report SCSI response. More...

int	scsi_open (struct interface block, struct interface scsi, struct scsi_lun *lun)
	Open SCSI device. More...

Variables
uint8_t	opcode
	Opcode (0x28) More...

uint8_t	flags
	Flags. More...

uint32_t	lba
	Start address. More...

uint8_t	group
	Group number. More...

uint16_t	len
	Transfer length. More...

uint8_t	control
	Control byte. More...

uint8_t	reserved_a
	Reserved. More...

uint8_t	reserved_b [3]
	Reserved. More...

uint32_t	blksize
	Block length in bytes. More...

uint8_t	service_action
	Service action. More...

uint8_t	reserved
	Reserved. More...

union scsi_cdb	__attribute__

uint16_t	u16 [4]

uint8_t	code
	Response code. More...

uint8_t	key
	Sense key. More...

uint32_t	info
	Information. More...

uint32_t	cs_info
	Command-specific information. More...

uint16_t	additional
	Additional sense code and qualifier. More...

Detailed Description

SCSI devices.

Definition in file scsi.h.

Macro Definition Documentation

◆ SCSI_MAX_BLOCK_10

#define SCSI_MAX_BLOCK_10 0xffffffffULL

Maximum block for READ/WRITE (10) commands.

Definition at line 17 of file scsi.h.

◆ SCSI_LUN_FORMAT

#define SCSI_LUN_FORMAT "%04x-%04x-%04x-%04x"

printf() format for dumping a scsi_lun

Definition at line 241 of file scsi.h.

◆ SCSI_LUN_DATA

#define SCSI_LUN_DATA ( lun )

Value:

ntohs ( (lun).u16[0] ), ntohs ( (lun).u16[1] ), \

ntohs ( (lun).u16[2] ), ntohs ( (lun).u16[3] )

u16

uint16_t u16

Definition: stdint.h:21

ntohs

#define ntohs(value)

Definition: byteswap.h:136

lun

uint8_t lun

Logical Unit Number.

Definition: edd.h:32

printf() parameters for dumping a scsi_lun

Definition at line 244 of file scsi.h.

◆ SCSI_SENSE_CODE_MASK

#define SCSI_SENSE_CODE_MASK 0x7f

SCSI sense response code mask.

Definition at line 309 of file scsi.h.

◆ SCSI_SENSE_FIXED

#define SCSI_SENSE_FIXED ( code ) ( ( (code) & 0x7e ) == 0x70 )

Test if SCSI sense data is in fixed format.

Parameters

code	Response code

Return values

is_fixed Sense data is in fixed format

Definition at line 316 of file scsi.h.

◆ SCSI_SENSE_KEY_MASK

#define SCSI_SENSE_KEY_MASK 0x0f

SCSI sense key mask.

Definition at line 319 of file scsi.h.

◆ scsi_command_TYPE

#define scsi_command_TYPE ( object_type )

Value:

typeof ( int ( object_type, struct interface *data, \

struct scsi_cmd *command ) )

command

A command-line command.

Definition: command.h:9

interface

An object interface.

Definition: interface.h:124

scsi_cmd

A SCSI command information unit.

Definition: scsi.h:249

data

uint8_t data[48]

Additional event data.

Definition: ena.h:22

typeof

typeof(acpi_finder=acpi_find)

ACPI table finder.

Definition: acpi.c:45

Definition at line 342 of file scsi.h.

◆ scsi_response_TYPE

#define scsi_response_TYPE ( object_type ) typeof ( void ( object_type, struct scsi_rsp *response ) )

Definition at line 347 of file scsi.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ scsi_parse_lun()

int scsi_parse_lun	(	const char *	lun_string,
		struct scsi_lun *	lun
	)

Parse SCSI LUN.

Parameters

lun_string	LUN string representation
lun	LUN to fill in

Return values

rc	Return status code

Definition at line 117 of file scsi.c.

                                                                     {
         char *p;
         int i;
 
         memset ( lun, 0, sizeof ( *lun ) );
         if ( lun_string ) {
                 p = ( char * ) lun_string;
                 for ( i = 0 ; i < 4 ; i++ ) {
                         lun->u16[i] = htons ( strtoul ( p, &p, 16 ) );
                         if ( *p == '\0' )
                                 break;
                         if ( *p != '-' )
                                 return -EINVAL;
                         p++;
                 }
                 if ( *p )
                         return -EINVAL;
         }
 
         return 0;
 }

References EINVAL, htons, lun, memset(), and strtoul().

Referenced by fcp_parse_uri(), ib_srp_parse_lun(), and iscsi_parse_root_path().

◆ scsi_parse_sense()

void scsi_parse_sense	(	const void *	data,
		size_t	len,
		struct scsi_sns_descriptor *	sense
	)

Parse SCSI sense data.

Parameters

data	Raw sense data
len	Length of raw sense data
sense	Descriptor-format sense data to fill in

Definition at line 146 of file scsi.c.

                                                             {
         const union scsi_sns *sns = data;
 
         /* Avoid returning uninitialised data */
         memset ( sense, 0, sizeof ( *sense ) );
 
         /* Copy, assuming descriptor-format data */
         if ( len < sizeof ( sns->desc ) )
                 return;
         memcpy ( sense, &sns->desc, sizeof ( *sense ) );
 
         /* Convert fixed-format to descriptor-format, if applicable */
         if ( len < sizeof ( sns->fixed ) )
                 return;
         if ( ! SCSI_SENSE_FIXED ( sns->code ) )
                 return;
         sense->additional = sns->fixed.additional;
 }

References scsi_sns_fixed::additional, scsi_sns_descriptor::additional, scsi_sns::code, data, scsi_sns::desc, scsi_sns::fixed, len, memcpy(), memset(), and SCSI_SENSE_FIXED.

Referenced by fcpcmd_recv_rsp(), iscsi_rx_scsi_response(), and srp_rsp().

◆ scsi_command()

int scsi_command	(	struct interface *	control,
		struct interface *	data,
		struct scsi_cmd *	command
	)

Issue SCSI command.

Parameters

control	SCSI control interface
data	SCSI data interface
command	SCSI command

Return values

tag	Command tag, or negative error

Definition at line 181 of file scsi.c.

                                               {
         struct interface *dest;
         scsi_command_TYPE ( void * ) *op =
                 intf_get_dest_op ( control, scsi_command, &dest );
         void *object = intf_object ( dest );
         int tap;
 
         if ( op ) {
                 tap = op ( object, data, command );
         } else {
                 /* Default is to fail to issue the command */
                 tap = -EOPNOTSUPP;
         }
 
         intf_put ( dest );
         return tap;
 }

References control, data, dest, EOPNOTSUPP, intf_get_dest_op, intf_object(), intf_put(), op, and scsi_command_TYPE.

◆ scsi_response()

void scsi_response	(	struct interface *	intf,
		struct scsi_rsp *	response
	)

Report SCSI response.

Parameters

interface	SCSI command interface
response	SCSI response

Definition at line 206 of file scsi.c.

                                                                          {
         struct interface *dest;
         scsi_response_TYPE ( void * ) *op =
                 intf_get_dest_op ( intf, scsi_response, &dest );
         void *object = intf_object ( dest );
 
         if ( op ) {
                 op ( object, response );
         } else {
                 /* Default is to ignore the response */
         }
 
         intf_put ( dest );
 }

References dest, interface::intf, intf_get_dest_op, intf_object(), intf_put(), op, scsi_response(), and scsi_response_TYPE.

Referenced by fcpcmd_recv_rsp(), iscsi_scsi_done(), scsi_response(), and srp_rsp().

◆ scsi_open()

int scsi_open	(	struct interface *	block,
		struct interface *	scsi,
		struct scsi_lun *	lun
	)

Open SCSI device.

Parameters

block	Block control interface
scsi	SCSI control interface
lun	SCSI LUN

Return values

rc	Return status code

Definition at line 984 of file scsi.c.

                                        {
         struct scsi_device *scsidev;
 
         /* Allocate and initialise structure */
         scsidev = zalloc ( sizeof ( *scsidev ) );
         if ( ! scsidev )
                 return -ENOMEM;
         ref_init ( &scsidev->refcnt, NULL );
         intf_init ( &scsidev->block, &scsidev_block_desc, &scsidev->refcnt );
         intf_init ( &scsidev->scsi, &scsidev_scsi_desc, &scsidev->refcnt );
         intf_init ( &scsidev->ready, &scsidev_ready_desc, &scsidev->refcnt );
         process_init ( &scsidev->process, &scsidev_process_desc,
                        &scsidev->refcnt );
         INIT_LIST_HEAD ( &scsidev->cmds );
         memcpy ( &scsidev->lun, lun, sizeof ( scsidev->lun ) );
         DBGC ( scsidev, "SCSI %p created for LUN " SCSI_LUN_FORMAT "\n",
                scsidev, SCSI_LUN_DATA ( scsidev->lun ) );
 
         /* Attach to SCSI and parent interfaces, mortalise self, and return */
         intf_plug_plug ( &scsidev->scsi, scsi );
         intf_plug_plug ( &scsidev->block, block );
         ref_put ( &scsidev->refcnt );
         return 0;
 }

References block, scsi_device::block, scsi_device::cmds, DBGC, ENOMEM, INIT_LIST_HEAD, intf_init(), intf_plug_plug(), lun, scsi_device::lun, memcpy(), NULL, scsi_device::process, process_init(), scsi_device::ready, ref_init, ref_put, scsi_device::refcnt, scsi_device::scsi, SCSI_LUN_DATA, SCSI_LUN_FORMAT, scsidev_block_desc, scsidev_process_desc, scsidev_ready_desc, scsidev_scsi_desc, and zalloc().

Referenced by fcpdev_open(), iscsi_open(), srp_open(), and usbblk_open_uri().

Variable Documentation

◆ opcode

uint8_t opcode

Opcode (0x28)

Opcode (0x00)

Opcode (0x9e)

Opcode (0x25)

Opcode (0x8a)

Opcode (0x2a)

Opcode (0x88)

Definition at line 16 of file scsi.h.

◆ flags

uint8_t flags

Flags.

Definition at line 18 of file scsi.h.

◆ group

uint8_t group

Group number.

Definition at line 25 of file scsi.h.

◆ len

uint8_t len

Transfer length.

Additional sense length.

This is a logical block count, in big-endian order.

This is the size of the data-in buffer, in bytes.

Definition at line 30 of file scsi.h.

◆ control

uint8_t control

Control byte.

Definition at line 32 of file scsi.h.

◆ reserved_a

uint8_t reserved_a

Reserved.

Definition at line 18 of file scsi.h.

◆ reserved_b

uint8_t reserved_b[3]

Reserved.

Definition at line 25 of file scsi.h.

◆ blksize

uint32_t blksize

Block length in bytes.

Definition at line 18 of file scsi.h.

◆ service_action

uint8_t service_action

Service action.

Definition at line 18 of file scsi.h.

◆ reserved

uint8_t reserved

Reserved.

Definition at line 30 of file scsi.h.

◆ u16

uint16_t u16[4]

Definition at line 15 of file scsi.h.

◆ code

uint8_t code

Response code.

Definition at line 16 of file scsi.h.

Referenced by ar9300_comp_hdr_unpack(), ar9300_compress_decision(), ar9300_eeprom_restore_internal(), cms_verify_fail_okx(), cms_verify_okx(), deflate_inflate(), dhcpv6_check_duid(), dhcpv6_option(), hook_bios_interrupt(), tls_client_hello(), tls_signature_hash_digest(), tls_signature_hash_pubkey(), and vesafb_rc().

◆ key

uint8_t key

Sense key.

Definition at line 20 of file scsi.h.

◆ info

uint32_t info

Information.

Definition at line 22 of file scsi.h.

◆ cs_info

uint32_t cs_info

Command-specific information.

Definition at line 26 of file scsi.h.

◆ additional

uint16_t additional

Additional sense code and qualifier.

Definition at line 28 of file scsi.h.

Referenced by drbg_generate(), drbg_generate_algorithm(), drbg_reseed(), drbg_reseed_algorithm(), hmac_drbg_generate(), hmac_drbg_reseed(), and rbg_generate().

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ SCSI_MAX_BLOCK_10

◆ SCSI_LUN_FORMAT

◆ SCSI_LUN_DATA

◆ SCSI_SENSE_CODE_MASK

◆ SCSI_SENSE_FIXED

◆ SCSI_SENSE_KEY_MASK

◆ scsi_command_TYPE

◆ scsi_response_TYPE

Function Documentation

◆ FILE_LICENCE()

◆ scsi_parse_lun()

◆ scsi_parse_sense()

◆ scsi_command()

◆ scsi_response()

◆ scsi_open()

Variable Documentation

◆ opcode

◆ flags

◆ group

◆ len

◆ control

◆ reserved_a

◆ reserved_b

◆ blksize

◆ service_action

◆ reserved

◆ u16

◆ code

◆ key

◆ info

◆ cs_info

◆ additional