scsi

package

v0.0.0-...-5fb8a3f Latest Latest Go to latest Published: Sep 30, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/monogon-dev/monogon

Documentation ¶

Rendered for

Overview ¶

INCITS 502 Revision 19 / SPC-5 R19

Index ¶

Constants
type AdditionalSenseCode
- func (a AdditionalSenseCode) ASK() uint8
- func (a AdditionalSenseCode) ASKQ() uint8
- func (a AdditionalSenseCode) IsKey(b AdditionalSenseCode) bool
- func (a AdditionalSenseCode) String() string
type CommandDataBuffer
- func (c *CommandDataBuffer) Bytes() ([]byte, error)
type DataTransferDirection
type Device
- func NewFromFd(fd syscall.Conn) (*Device, error)
- func Open(path string) (*Device, error)
- func (d *Device) Close() error
- func (d *Device) GetInformationalExceptions() (*InformationalExceptions, error)
- func (d Device) Inquiry() (*InquiryData, error)
- func (d *Device) InquiryVPD(pageCode VPDPageCode, initialSize uint16) ([]byte, error)
- func (d *Device) LogSenseParameters(r LogSenseRequest) (map[uint16][]LogParameter, error)
- func (d *Device) LogSenseRaw(r LogSenseRequest) ([]byte, error)
- func (d *Device) RawCommand(c *CommandDataBuffer) error
- func (d *Device) ReadDefectDataLBA(plist, glist bool) ([]uint64, error)
- func (d *Device) ReadDefectDataPhysical(plist, glist bool) ([]PhysicalSectorFormatAddress, error)
- func (d *Device) SolidStateMediaHealth() (*SolidStateMediaHealth, error)
- func (d *Device) SupportedLogPages() (map[uint8]bool, error)
- func (d *Device) SupportedLogPagesAndSubpages() (map[PageAndSubpage]bool, error)
- func (d *Device) SupportedLogSubPages(pageCode uint8) (map[uint8]bool, error)
- func (d *Device) SupportedVPDPages() (map[VPDPageCode]bool, error)
- func (d *Device) UnitSerialNumber() (string, error)
type DeviceType
- func (d DeviceType) String() string
type FixedError
- func (e FixedError) Error() string
type InformationalExceptions
type InquiryData
type LogParameter
type LogSenseRequest
type OperationCode
type PageAndSubpage
- func NewPageAndSubpage(page, subpage uint8) PageAndSubpage
- func (p PageAndSubpage) Page() uint8
- func (p PageAndSubpage) String() string
- func (p PageAndSubpage) Subpage() uint8
type PhysicalSectorFormatAddress
type SenseKey
- func (s SenseKey) String() string
type SolidStateMediaHealth
type UnknownError
- func (e *UnknownError) Error() string
type VPDPageCode
- func (v VPDPageCode) String() string
type Version
- func (v Version) String() string

Constants ¶

View Source

const (
	SPC1 = 0x03
	SPC2 = 0x04
	SPC3 = 0x05
	SPC4 = 0x06
	SPC5 = 0x07
)

View Source

const (
	SG_IO                = 0x2285
	SG_DXFER_NONE        = -0x1
	SG_DXFER_TO_DEV      = -0x2
	SG_DXFER_FROM_DEV    = -0x3
	SG_DXFER_TO_FROM_DEV = -0x4
)

View Source

const (
	// AllSectors is a magic sector number indicating that it applies to all
	// sectors on the track.
	AllSectors = math.MaxUint16
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

func (AdditionalSenseCode) ASK ¶

func (a AdditionalSenseCode) ASK() uint8

ASK returns the raw Additional Sense Key

func (AdditionalSenseCode) ASKQ ¶

func (a AdditionalSenseCode) ASKQ() uint8

ASKQ returns the raw Additional Sense Key Qualifier

func (AdditionalSenseCode) IsKey ¶

func (a AdditionalSenseCode) IsKey(b AdditionalSenseCode) bool

IsKey checks if the ASK portion of a is the same as the ASK portion of b.

func (AdditionalSenseCode) String ¶

func (a AdditionalSenseCode) String() string

String returns the textual representation of this ASK

func (*CommandDataBuffer) Bytes ¶

func (c *CommandDataBuffer) Bytes() ([]byte, error)

Bytes returns the raw CDB to be sent to the device

type DataTransferDirection ¶

type DataTransferDirection uint8

const (
	DataTransferNone DataTransferDirection = iota
	DataTransferToDevice
	DataTransferFromDevice
	DataTransferBidirectional
)

func NewFromFd ¶

func NewFromFd(fd syscall.Conn) (*Device, error)

NewFromFd creates a new SCSI device handle from a system handle.

func Open ¶

func Open(path string) (*Device, error)

Open creates a new SCSI device handle from a device path (like /dev/sda).

func (*Device) Close ¶

func (d *Device) Close() error

Close closes the SCSI device handle if opened by Open()

func (*Device) GetInformationalExceptions ¶

func (d *Device) GetInformationalExceptions() (*InformationalExceptions, error)

func (Device) Inquiry ¶

func (d Device) Inquiry() (*InquiryData, error)

Inquiry queries the device for various metadata about its identity and supported features.

func (*Device) InquiryVPD ¶

func (d *Device) InquiryVPD(pageCode VPDPageCode, initialSize uint16) ([]byte, error)

InquiryVPD requests a specified Vital Product Description Page from the device. If the size of the page is known in advance, initialSize should be set to a non-zero value to make the query more efficient.

func (*Device) LogSenseParameters ¶

func (d *Device) LogSenseParameters(r LogSenseRequest) (map[uint16][]LogParameter, error)

LogSenseParameters returns the parameters of a log page. The returned map contains one entry per parameter ID in the result. The order of parameters of the same ID is kept.

func (*Device) LogSenseRaw ¶

func (d *Device) LogSenseRaw(r LogSenseRequest) ([]byte, error)

LogSenseRaw requests a raw log page. For log pages with parameters LogSenseParameters is better-suited.

func (*Device) RawCommand ¶

func (d *Device) RawCommand(c *CommandDataBuffer) error

RawCommand issues a raw command against the device.

func (*Device) ReadDefectDataLBA ¶

func (d *Device) ReadDefectDataLBA(plist, glist bool) ([]uint64, error)

ReadDefectDataLBA reads the primary (manufacturer) and/or grown defect list in LBA format. This is commonly used on SSDs and generally returns an error on spinning drives.

func (*Device) ReadDefectDataPhysical ¶

func (d *Device) ReadDefectDataPhysical(plist, glist bool) ([]PhysicalSectorFormatAddress, error)

ReadDefectDataPhysical reads the primary (manufacturer) and/or grown defect list in physical format. This is only defined for spinning drives, returning an error on SSDs.

func (*Device) SolidStateMediaHealth ¶

func (d *Device) SolidStateMediaHealth() (*SolidStateMediaHealth, error)

SolidStateMediaHealth reports parameters about the health of the solid-state media of a SCSI block device.

func (*Device) SupportedLogPages ¶

func (d *Device) SupportedLogPages() (map[uint8]bool, error)

SupportedLogPages returns a map with all supported log pages. This can return an error if the device does not support logs at all.

func (*Device) SupportedLogPagesAndSubpages ¶

func (d *Device) SupportedLogPagesAndSubpages() (map[PageAndSubpage]bool, error)

SupportedLogPagesAndSubpages returns the list of supported pages and subpages. This can return an error if the device does not support logs at all.

func (*Device) SupportedLogSubPages ¶

func (d *Device) SupportedLogSubPages(pageCode uint8) (map[uint8]bool, error)

SupportedLogSubPages returns the list of subpages supported in a log page.

func (*Device) SupportedVPDPages ¶

func (d *Device) SupportedVPDPages() (map[VPDPageCode]bool, error)

SupportedVPDPages returns the list of supported vital product data pages supported by the device.

func (*Device) UnitSerialNumber ¶

func (d *Device) UnitSerialNumber() (string, error)

UnitSerialNumber returns the serial number of the device. Only available if UnitSerialNumberVPD is a supported VPD page.

type DeviceType ¶

type DeviceType uint8

DeviceType represents a SCSI peripheral device type, which can be used to determine the command set to use to control the device. See Table 150 in the standard.

const (
	TypeBlockDevice              DeviceType = 0x00
	TypeSequentialAccessDevice   DeviceType = 0x01
	TypeProcessor                DeviceType = 0x03
	TypeOpticalDrive             DeviceType = 0x05
	TypeOpticalMemory            DeviceType = 0x07
	TypeMediaChanger             DeviceType = 0x08
	TypeArrayController          DeviceType = 0x0c
	TypeEncloseServices          DeviceType = 0x0d
	TypeOpticalCardRWDevice      DeviceType = 0x0f
	TypeObjectStorageDevice      DeviceType = 0x11
	TypeAutomationDriveInterface DeviceType = 0x12
	TypeZonedBlockDevice         DeviceType = 0x14
	TypeUnknownDevice            DeviceType = 0x1f
)

func (DeviceType) String ¶

func (d DeviceType) String() string

type FixedError ¶

type FixedError struct {
	Deferred                   bool
	SenseKey                   SenseKey
	Information                uint32
	CommandSpecificInformation uint32
	AdditionalSenseCode        AdditionalSenseCode
}

FixedError is one type of error returned by a SCSI CHECK_CONDITION. See also Table 48 in the standard.

func (FixedError) Error ¶

func (e FixedError) Error() string

type InformationalExceptions ¶

type InformationalExceptions struct {
	InformationalSenseCode AdditionalSenseCode
	Temperature            uint8
}

type InquiryData ¶

type InquiryData struct {
	PeriperalQualifier      uint8
	PeripheralDeviceType    DeviceType
	RemovableMedium         bool
	LogicalUnitConglomerate bool
	CommandSetVersion       Version
	NormalACASupported      bool
	HistoricalSupport       bool
	ResponseDataFormat      uint8
	SCCSupported            bool
	TargetPortGroupSupport  uint8
	ThirdPartyCopySupport   bool
	HasProtectionInfo       bool
	HasEnclosureServices    bool
	VendorFeature1          bool
	HasMultipleSCSIPorts    bool
	CmdQueue                bool
	VendorFeature2          bool
	Vendor                  string
	Product                 string
	ProductRevisionLevel    string
	VendorSpecific          []byte
	VersionDescriptors      []uint16
}

InquiryData contains data returned by the INQUIRY command.

type LogParameter ¶

type LogParameter struct {
	// DisableUpdate indicates if the device is updating this parameter.
	// If this is true the parameter has either overflown or updating has been
	// manually disabled.
	DisableUpdate bool
	// TargetSaveDisable indicates if automatic saving of this parameter has
	// been disabled.
	TargetSaveDisable bool
	// FormatAndLinking contains the format of the log parameter.
	FormatAndLinking uint8
	// Data contains the payload of the log parameter.
	Data []byte
}

type LogSenseRequest ¶

type LogSenseRequest struct {
	// PageCode contains the identifier of the requested page
	PageCode uint8
	// SubpageCode contains the identifier of the requested subpage
	// or the zero value if no subpage is requested.
	SubpageCode uint8
	// PageControl specifies what type of values should be returned for bounded
	// and unbounded log parameters. See also Table 156 in the standard.
	PageControl uint8
	// ParameterPointer allows requesting parameter data beginning from a
	// specific parameter code. The zero value starts from the beginning.
	ParameterPointer uint16
	// SaveParameters requests the device to save all parameters without
	// DisableUpdate set to non-volatile storage.
	SaveParameters bool
	// InitialSize is an optional hint how big the buffer for the log page
	// should be for the initial request. The zero value sets this to 4096.
	InitialSize uint16
}

type OperationCode ¶

type OperationCode uint8

const (
	InquiryOp        OperationCode = 0x12
	ReadDefectDataOp OperationCode = 0x37
	LogSenseOp       OperationCode = 0x4d
)

type PageAndSubpage ¶

type PageAndSubpage uint16

PageAndSubpage identifies a log page uniquely.

func NewPageAndSubpage ¶

func NewPageAndSubpage(page, subpage uint8) PageAndSubpage

func (PageAndSubpage) Page ¶

func (p PageAndSubpage) Page() uint8

func (PageAndSubpage) String ¶

func (p PageAndSubpage) String() string

func (PageAndSubpage) Subpage ¶

func (p PageAndSubpage) Subpage() uint8

type PhysicalSectorFormatAddress ¶

type PhysicalSectorFormatAddress struct {
	CylinderNumber              uint32
	HeadNumber                  uint8
	SectorNumber                uint32
	MultiAddressDescriptorStart bool
}

PhysicalSectorFormatAddress represents a physical sector (or the the whole track if SectorNumber == AllSectors) on a spinning hard drive.

type SenseKey ¶

type SenseKey uint8

SenseKey represents the top-level status code of a SCSI sense response.

const (
	NoSense        SenseKey = 0x0
	RecoveredError SenseKey = 0x1
	NotReady       SenseKey = 0x2
	MediumError    SenseKey = 0x3
	HardwareError  SenseKey = 0x4
	IllegalRequest SenseKey = 0x5
	UnitAttention  SenseKey = 0x6
	DataProtect    SenseKey = 0x7
	BlankCheck     SenseKey = 0x8
	VendorSpecific SenseKey = 0x9
	CopyAborted    SenseKey = 0xa
	AbortedCommand SenseKey = 0xb
	VolumeOverflow SenseKey = 0xd
	Miscompare     SenseKey = 0xe
	Completed      SenseKey = 0xf
)

func (SenseKey) String ¶

func (s SenseKey) String() string

type SolidStateMediaHealth ¶

type SolidStateMediaHealth struct {
	// PercentageUsedEnduranceIndicator is a value which represents a
	// vendor-specific wear estimate of the solid state medium.
	// A new device starts at 0, at 100 the device is considered end-of-life.
	// Values up to 255 are possible.
	PercentageUsedEnduranceIndicator uint8
}

type UnknownError ¶

type UnknownError struct {
	RawSenseData []byte
}

UnknownError is a type of error returned by SCSI which is not understood by this library. This can be a vendor-specific or future error.

func (*UnknownError) Error ¶

func (e *UnknownError) Error() string

type VPDPageCode ¶

type VPDPageCode uint8

VPDPageCode see Table 498

const (
	SupportedVPDs                      VPDPageCode = 0x00
	UnitSerialNumberVPD                VPDPageCode = 0x80
	DeviceIdentificationVPD            VPDPageCode = 0x83
	SoftwareInterfaceIdentificationVPD VPDPageCode = 0x84
	ManagementNetworkAddressesVPD      VPDPageCode = 0x85
	ExtendedINQUIRYDataVPD             VPDPageCode = 0x86
	ModePagePolicyVPD                  VPDPageCode = 0x87
	SCSIPortsVPD                       VPDPageCode = 0x88
	ATAInformationVPD                  VPDPageCode = 0x89
	PowerConditionVPD                  VPDPageCode = 0x8a
	DeviceConstituentsVPD              VPDPageCode = 0x8b
)

func (VPDPageCode) String ¶

func (v VPDPageCode) String() string

type Version ¶

type Version uint8

Version represents a specific standardized version of the SCSI primary command set (SPC). The enum values are sorted, so for example version >= SPC3 is true for SPC-3 and all later standards. See table 151 in the standard.

func (Version) String ¶

func (v Version) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type AdditionalSenseCode ¶

func (AdditionalSenseCode) ASK ¶

func (AdditionalSenseCode) ASKQ ¶

func (AdditionalSenseCode) IsKey ¶

func (AdditionalSenseCode) String ¶

type CommandDataBuffer ¶

func (*CommandDataBuffer) Bytes ¶

type DataTransferDirection ¶

type Device ¶

func NewFromFd ¶

func Open ¶

func (*Device) Close ¶

func (*Device) GetInformationalExceptions ¶

func (Device) Inquiry ¶

func (*Device) InquiryVPD ¶

func (*Device) LogSenseParameters ¶

func (*Device) LogSenseRaw ¶

func (*Device) RawCommand ¶

func (*Device) ReadDefectDataLBA ¶

func (*Device) ReadDefectDataPhysical ¶

func (*Device) SolidStateMediaHealth ¶

func (*Device) SupportedLogPages ¶

func (*Device) SupportedLogPagesAndSubpages ¶

func (*Device) SupportedLogSubPages ¶

func (*Device) SupportedVPDPages ¶

func (*Device) UnitSerialNumber ¶

type DeviceType ¶

func (DeviceType) String ¶

type FixedError ¶

func (FixedError) Error ¶

type InformationalExceptions ¶

type InquiryData ¶

type LogParameter ¶

type LogSenseRequest ¶

type OperationCode ¶

type PageAndSubpage ¶

func NewPageAndSubpage ¶

func (PageAndSubpage) Page ¶

func (PageAndSubpage) String ¶

func (PageAndSubpage) Subpage ¶

type PhysicalSectorFormatAddress ¶

type SenseKey ¶

func (SenseKey) String ¶

type SolidStateMediaHealth ¶

type UnknownError ¶

func (*UnknownError) Error ¶

type VPDPageCode ¶

func (VPDPageCode) String ¶

type Version ¶

func (Version) String ¶

Source Files ¶