ATA commands

ATA commands — Helper routines for ATA commands

Synopsis

enum                StoragedAtaCommandProtocol;
                    StoragedAtaCommandInput;
                    StoragedAtaCommandOutput;
gboolean            storaged_ata_send_command_sync      (gint fd,
                                                         gint timeout_msec,
                                                         StoragedAtaCommandProtocol protocol,
                                                         StoragedAtaCommandInput *input,
                                                         StoragedAtaCommandOutput *output,
                                                         GError **error);

Description

Helper routines for sending ATA commands to a device.

Details

enum StoragedAtaCommandProtocol

typedef enum {
  STORAGED_ATA_COMMAND_PROTOCOL_NONE,
  STORAGED_ATA_COMMAND_PROTOCOL_DRIVE_TO_HOST,
  STORAGED_ATA_COMMAND_PROTOCOL_HOST_TO_DRIVE
} StoragedAtaCommandProtocol;

Enumeration used to specify the protocol of an ATA command

`STORAGED_ATA_COMMAND_PROTOCOL_NONE`	Non-data
`STORAGED_ATA_COMMAND_PROTOCOL_DRIVE_TO_HOST`	PIO Data-In
`STORAGED_ATA_COMMAND_PROTOCOL_HOST_TO_DRIVE`	PIO Data-Out

StoragedAtaCommandInput

typedef struct {
  guint8  command;
  guint8  feature;
  guint8  count;
  guint8  device;
  guint32 lba;
  gsize   buffer_size;
  guchar *buffer;
} StoragedAtaCommandInput;

Struct used for input data when sending ATA commands.

guint8 `command`;	Command
guint8 `feature`;	Feature
guint8 `count`;	Count
guint8 `device`;	Device
guint32 `lba`;	LBA
gsize `buffer_size`;	Size of the `buffer` member or 0
guchar *`buffer`;	Data to send to device or `NULL`

StoragedAtaCommandOutput

typedef struct {
  guint8  error;
  guint8  count;
  guint8  device;
  guint8  status;
  guint32 lba;
  gsize   buffer_size;
  guchar *buffer;
} StoragedAtaCommandOutput;

Struct used for output data when sending ATA commands.

guint8 `error`;	Error
guint8 `count`;	Count
guint8 `device`;	Device
guint8 `status`;	Status
guint32 `lba`;	LBA
gsize `buffer_size`;	Size of the `buffer` member or 0
guchar *`buffer`;	Pointer to where to recieve data from the device or `NULL`

storaged_ata_send_command_sync ()

gboolean            storaged_ata_send_command_sync      (gint fd,
                                                         gint timeout_msec,
                                                         StoragedAtaCommandProtocol protocol,
                                                         StoragedAtaCommandInput *input,
                                                         StoragedAtaCommandOutput *output,
                                                         GError **error);

Sends a command to an ATA device. Blocks the calling thread while the command is pending.

`fd` :	A file descriptor for a ATA device.
`timeout_msec` :	Timeout in milli-seconds for the command. Use -1 for the default (5 seconds) timeout and `G_MAXINT` for no timeout.
`protocol` :	The direction of the command.
`input` :	The input for the command.
`output` :	The output for the command.
`error` :	Return location for error or `NULL`.
Returns :	`TRUE` if the command succeded, `FALSE` if `error` is set.

			Storaged Reference Manual
Top \| Description