Difference between revisions of "Unit Storage"

From Ultibo.org
Jump to: navigation, search
Line 20: Line 20:
 
----
 
----
  
−
''To be documented''
+
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Storage specific constants''' <code> STORAGE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>STORAGE_NAME_PREFIX = 'Storage';</code>
 +
| Name prefix for Storage Devices
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>STORAGE_STATUS_TIMER_INTERVAL = 1000;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Storage device type constants''' <code> STORAGE_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>STORAGE_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>STORAGE_TYPE_HDD = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_TYPE_FDD = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_TYPE_CDROM = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_TYPE_OPTICAL = 4;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_TYPE_TAPE = 5;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_TYPE_REMOVABLE = 6;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>STORAGE_TYPE_MAX = 6;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Storage device state constants''' <code> STORAGE_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>STORAGE_STATE_EJECTED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>STORAGE_STATE_EJECTING = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_STATE_INSERTING = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_STATE_INSERTED = 3;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>STORAGE_STATE_MAX = 3;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Storage device flag constants''' <code> STORAGE_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>STORAGE_FLAG_NONE = $00000000;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_REMOVABLE = $00000001;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_LBA48 = $00000002;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_NOT_READY = $00000004;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_NO_MEDIA = $00000008;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_READ_ONLY = $00000010;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_WRITE_ONLY = $00000020;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_ERASEABLE = $00000040;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_LOCKABLE = $00000080;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_LOCKED = $00000100;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_EJECTABLE = $00000200;</code>
 +
| &nbsp;
 +
|-
 +
| <code>STORAGE_FLAG_CHANGABLE = $00000400;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Storage device control code constants''' <code> STORAGE_CONTROL_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>STORAGE_CONTROL_TEST_READY = 1;</code>
 +
| Test Unit Ready
 +
|-
 +
| <code>STORAGE_CONTROL_RESET = 2;</code>
 +
| Reset Device
 +
|-
 +
| <code>STORAGE_CONTROL_TEST_MEDIA = 3;</code>
 +
| Test No Media
 +
|-
 +
| <code>STORAGE_CONTROL_LOCK = 4;</code>
 +
| Lock Media
 +
|-
 +
| <code>STORAGE_CONTROL_UNLOCK = 5;</code>
 +
| Unlock Media
 +
|-
 +
| <code>STORAGE_CONTROL_EJECT = 6;</code>
 +
| Eject Media
 +
|-
 +
| <code>STORAGE_CONTROL_TEST_LOCKED = 7;</code>
 +
| Test Media Locked
 +
|-
 +
| <code>STORAGE_CONTROL_TEST_CHANGED = 8;</code>
 +
| Test Media Changed
 +
|-
 +
| <code>STORAGE_CONTROL_GET_VENDORID = 9;</code>
 +
| Get Vendor ID
 +
|-
 +
| <code>STORAGE_CONTROL_GET_PRODUCTID = 10;</code>
 +
| Get Product ID
 +
|-
 +
| <code>STORAGE_CONTROL_GET_SERIAL = 11;</code>
 +
| Get Serial No
 +
|-
 +
| <code>STORAGE_CONTROL_GET_REVISION = 12;</code>
 +
| Get Revision No
 +
|-
 +
| <code>STORAGE_CONTROL_GET_PRODUCT = 13;</code>
 +
| Get Product Name
 +
|-
 +
| <code>STORAGE_CONTROL_GET_MANUFACTURER = 14;</code>
 +
| Get Manufacturer Name
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Storage logging constants''' <code> STORAGE_LOG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>STORAGE_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;</code>
 +
| Storage debugging messages
 +
|-
 +
| <code>STORAGE_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 +
| Storage informational messages, such as a device being attached or detached
 +
|-
 +
| <code>STORAGE_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 +
| Storage error messages
 +
|-
 +
| <code>STORAGE_LOG_LEVEL_NONE = LOG_LEVEL_NONE;</code>
 +
| No Storage messages
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Type definitions ===
 
=== Type definitions ===

Revision as of 03:20, 29 November 2016

Return to Unit Reference


Description

Storage Devices

This unit provides both the Storage device interface and the generic USB mass storage driver.

USB Mass Storage Devices

The USB Mass Storage Class Control/Bulk/Interrupt (CBI) Transport specification is approved for use only with full-speed floppy disk drives. CBI shall not be used in high-speed capable devices, or in devices other than floppy disk drives. CBI shall not be used in devices that implement LSDFS. Usage of CBI for any new design is discouraged.

Therefore the majority of USB Mass Storage devices use the Bulk only interface.

USB mass storage class devices normally use the SCSI command set and therefore the USB storage driver consumes the SCSI unit for the protocol and command definitions. USB mass storage devices are registered directly as Storage devices not as SCSI devices.

Constants


[Expand]
Storage specific constants STORAGE_*


[Expand]
Storage device type constants STORAGE_TYPE_*


[Expand]
Storage device state constants STORAGE_STATE_*


[Expand]
Storage device flag constants STORAGE_FLAG_*


[Expand]
Storage device control code constants STORAGE_CONTROL_*


[Expand]
Storage logging constants STORAGE_LOG_*


Type definitions

To be documented

Public variables

To be documented

Function declarations


Initialization functions

[Expand] 
procedure StorageInit;
Description: To be documented


Storage functions

[Expand] 
function StorageDeviceRead(Storage:PStorageDevice; const Start,Count:Int64; Buffer:Pointer):LongWord;
Description: To be documented


[Expand] 
function StorageDeviceWrite(Storage:PStorageDevice; const Start,Count:Int64; Buffer:Pointer):LongWord;
Description: To be documented


[Expand] 
function StorageDeviceErase(Storage:PStorageDevice; const Start,Count:Int64):LongWord;
Description: To be documented


[Expand] 
function StorageDeviceControl(Storage:PStorageDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;
Description: To be documented


[Expand] 
function StorageDeviceSetState(Storage:PStorageDevice; State:LongWord):LongWord;
Description: Set the state of the specified storage and send a notification


[Expand] 
function StorageDeviceStartStatus(Storage:PStorageDevice; Interval:LongWord):LongWord;
Description: Start status monitoring on the specified storage for insert/eject notifications


[Expand] 
function StorageDeviceStopStatus(Storage:PStorageDevice):LongWord;
Description: Stop status monitoring on the specified storage for insert/eject notifications


[Expand] 
function StorageDeviceCreate:PStorageDevice;
Description: Create a new Storage entry


[Expand] 
function StorageDeviceCreateEx(Size:LongWord):PStorageDevice;
Description: Create a new Storage entry


[Expand] 
function StorageDeviceDestroy(Storage:PStorageDevice):LongWord;
Description: Destroy an existing Storage entry


[Expand] 
function StorageDeviceRegister(Storage:PStorageDevice):LongWord;
Description: Register a new Storage in the Storage table


[Expand] 
function StorageDeviceDeregister(Storage:PStorageDevice):LongWord;
Description: Deregister a Storage from the Storage table


[Expand] 
function StorageDeviceFind(StorageId:LongWord):PStorageDevice;
Description: To be documented


[Expand] 
function StorageDeviceFindByName(const Name:String):PStorageDevice; inline;
Description: To be documented


[Expand] 
function StorageDeviceFindByDescription(const Description:String):PStorageDevice; inline;
Description: To be documented


[Expand] 
function StorageDeviceEnumerate(Callback:TStorageEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function StorageDeviceNotification(Storage:PStorageDevice; Callback:TStorageNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


USB storage functions

[Expand] 
function USBStorageDeviceRead(Storage:PStorageDevice; const Start,Count:Int64; Buffer:Pointer):LongWord;
Description: To be documented


[Expand] 
function USBStorageDeviceWrite(Storage:PStorageDevice; const Start,Count:Int64; Buffer:Pointer):LongWord;
Description: To be documented


[Expand] 
function USBStorageDeviceControl(Storage:PStorageDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;
Description: To be documented


[Expand] 
function USBStorageDriverBind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;
Description: Bind the Storage driver to a USB device if it is suitable


[Expand] 
function USBStorageDriverUnbind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;
Description: Unbind the Storage driver from a USB device


[Expand] 
procedure USBStorageReadComplete(Request:PUSBRequest);
Description: Called when a USB request from a USB storage bulk IN endpoint completes


[Expand] 
procedure USBStorageWriteComplete(Request:PUSBRequest);
Description: Called when a USB request from a USB storage bulk OUT endpoint completes


[Expand] 
procedure USBStorageInterruptComplete(Request:PUSBRequest);
Description: Called when a USB request from a USB storage IN interrupt endpoint completes


Storage helper functions

[Expand] 
function StorageGetCount:LongWord; inline;
Description: Get the current storage count


[Expand] 
function StorageDeviceCheck(Storage:PStorageDevice):PStorageDevice;
Description: Check if the supplied Storage is in the storage table


[Expand] 
function StorageDeviceTypeToString(StorageType:LongWord):String;
Description: To be documented


[Expand] 
function StorageDeviceStateToString(StorageState:LongWord):String;
Description: To be documented


[Expand] 
function StorageDeviceStateToNotification(State:LongWord):LongWord;
Description: Convert a Storage state value into the notification code for device notifications


[Expand] 
procedure StorageLog(Level:LongWord; Storage:PStorageDevice; const AText:String);
Description: To be documented


[Expand] 
procedure StorageLogInfo(Storage:PStorageDevice; const AText:String);
Description: To be documented


[Expand] 
procedure StorageLogError(Storage:PStorageDevice; const AText:String);
Description: To be documented


[Expand] 
procedure StorageLogDebug(Storage:PStorageDevice; const AText:String);
Description: To be documented


[Expand] 
procedure StorageStatusTimer(Storage:PStorageDevice);
Description: To be documented


USB storage helper functions

[Expand] 
function USBStorageCheckSubclass(Subclass:Byte):Boolean;
Description: To be documented


[Expand] 
function USBStorageCheckProtocol(Protocol:Byte):Boolean;
Description: To be documented


[Expand] 
function USBStorageBlockSizeToBlockShift(BlockSize:LongWord):LongWord;
Description: To be documented


[Expand] 
function USBStoragePatchDevice(Device:PUSBDevice; var Subclass,Protocol:Byte):LongWord;
Description: A function to adjust the subclass and protocol parameters of known defective devices


[Expand] 
function USBStorageFixupDevice(Device:PUSBDevice; var Vendor,Product:String):LongWord;
Description: A function to adjust the vendor and product parameters of known defective devices


[Expand] 
function USBStorageDeviceLock(Device:PUSBDevice; Storage:PUSBStorageDevice):LongWord;
Description: Issue a Prevent Media Removal request to a storage device


[Expand] 
function USBStorageDeviceUnlock(Device:PUSBDevice; Storage:PUSBStorageDevice):LongWord;
Description: Issue a Allow Media Removal request to a storage device


[Expand] 
function USBStorageDeviceLoad(Device:PUSBDevice; Storage:PUSBStorageDevice):LongWord;
Description: Issue a Start Stop request to a storage device


[Expand] 
function USBStorageDeviceEject(Device:PUSBDevice; Storage:PUSBStorageDevice):LongWord;
Description: Issue a Start Stop request to a storage device


[Expand] 
function USBStorageDeviceReset(Device:PUSBDevice; Storage:PUSBStorageDevice):LongWord;
Description: Issue a Storage Reset request to a storage device


[Expand] 
function USBStorageDeviceGetInfo(Device:PUSBDevice; Storage:PUSBStorageDevice):LongWord;
Description: Obtain basic information about a storage device (Type, Size, State, Product etc)


[Expand] 
function USBStorageDeviceGetStatus(Device:PUSBDevice; Storage:PUSBStorageDevice):LongWord;
Description: To be documented


[Expand] 
function USBStorageDeviceGetMaxLUN(Device:PUSBDevice; Storage:PUSBStorageDevice; var MaxLUN:Byte):LongWord;
Description: Issue a Get Max LUN request to a storage device


[Expand] 
function USBStorageDeviceClearStall(Device:PUSBDevice; Storage:PUSBStorageDevice; Endpoint:PUSBEndpointDescriptor):LongWord;
Description: Issue a USB Clear Feature (HALT) to the supplied endpoint on a storage device


[Expand] 
function USBStorageDeviceInquiry(Device:PUSBDevice; Storage:PUSBStorageDevice; var DeviceType,DeviceFlags:LongWord;v ar Vendor,Product,Revision:PChar):LongWord;
Description: Issue a SCSI Inquiry command to a LUN on a storage device


[Expand] 
function USBStorageDeviceRequestSense(Device:PUSBDevice; Storage:PUSBStorageDevice; var SenseKey,ASC,ASCQ:Byte):LongWord;
Description: Issue a SCSI Request Sense command to a LUN on a storage device


[Expand] 
function USBStorageDeviceReadCapacity(Device:PUSBDevice; Storage:PUSBStorageDevice; var BlockSize,BlockShift:LongWord; var BlockCount:Int64):LongWord;
Description: Issue a SCSI Read Capacity command to a LUN on a storage device


[Expand] 
function USBStorageDeviceTestUnitReady(Device:PUSBDevice; Storage:PUSBStorageDevice; var DeviceFlags:LongWord):LongWord;
Description: Issue a SCSI Test Unit Ready command to a LUN on a storage device


[Expand] 
function USBStorageDeviceRead10(Device:PUSBDevice; Storage:PUSBStorageDevice; Start:LongWord;Count:Word; Buffer:Pointer):LongWord;
Description: Issue a SCSI Read10 command to a LUN on a storage device


[Expand] 
function USBStorageDeviceWrite10(Device:PUSBDevice; Storage:PUSBStorageDevice; Start:LongWord; Count:Word; Buffer:Pointer):LongWord;
Description: Issue a SCSI Write10 command to a LUN on a storage device


[Expand] 
function USBStorageDeviceRead16(Device:PUSBDevice; Storage:PUSBStorageDevice; const Start,Count:Int64; Buffer:Pointer):LongWord;
Description: Issue a SCSI Read16 command to a LUN on a storage device


[Expand] 
function USBStorageDeviceWrite16(Device:PUSBDevice; Storage:PUSBStorageDevice; const Start,Count:Int64; Buffer:Pointer):LongWord;
Description: Issue a SCSI Write16 command to a LUN on a storage device


[Expand] 
function USBStorageDeviceTransport(Device:PUSBDevice; Storage:PUSBStorageDevice; Command:PUSBCommandBlock):LongWord;
Description: Perform the appropriate transport sequence for the device based on subclass and protocol


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_Storage&oldid=1794"