common_types.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include <time.h>

Go to the source code of this file.

Data Structures

struct  fio_progress_callback2
 structure used to register for callbacks from the SDK. All operations will block until they are complete, so the only way to tell how far along they are is to register with callbacks via this structure More...
struct  fio_pciexpress_info
 Struct containing 'static' PCIexpress info, that should not change during operation. More...
struct  fio_pci_info
 "Static" PCI information for the device More...
struct  fio_iodimm_dynamic_pci_info
 PCIe dynamic information that may change during operation. More...
struct  fio_firmware_version
 Firmware version. More...
struct  fio_firmware_version_info
 Firmware version information. More...

Defines

#define DllExport

Typedefs

typedef void(* fio_cb_fn_t )(uint64_t id, int16_t percent, void *context)
 Callback function for receiving progress updates.
typedef struct
fio_progress_callback2 
fio_progress_callback2_t
 structure used to register for callbacks from the SDK. All operations will block until they are complete, so the only way to tell how far along they are is to register with callbacks via this structure
typedef struct fio_pciexpress_info fio_pciexpress_info_t
 Struct containing 'static' PCIexpress info, that should not change during operation.
typedef struct fio_pci_info fio_pci_info_t
 "Static" PCI information for the device
typedef struct
fio_iodimm_dynamic_pci_info 
fio_iodimm_dynamic_pci_info_t
 PCIe dynamic information that may change during operation.
typedef struct fio_firmware_version fio_firmware_version_t
 Firmware version.
typedef struct
fio_firmware_version_info 
fio_firmware_version_info_t
 Firmware version information.

Enumerations

enum  fio_iodimm_compatibility_t { COMPATIBILITY_INCOMPATIBLE = 0x000, COMPATIBILITY_SUBOPTIMAL = 0x010, COMPATIBILITY_OPTIMAL = 0x800, COMPATIBILITY_UNKNOWN = 0x8000 }
 

Enumeration of compatibility levels a slot and card may have.

More...
enum  fio_pcie_linkspeed_t { FIO_PCIE_LINKSPEED_UNAVAIL = 0, FIO_PCIE_LINKSPEED_2_5 = 1, FIO_PCIE_LINKSPEED_5_0 = 2 }
 

Possible speeds that a PCIe link may have, in Gbits per second.

More...
enum  fio_status_result_t {
  FIO_STATUS_SUCCESS = 0, FIO_STATUS_DEVICE_NOT_FOUND = 1, FIO_STATUS_FAILURE = 2, FIO_STATUS_FAILURE_PERM = 3,
  FIO_STATUS_NOT_IMPLEMENTED = 4, FIO_STATUS_ENOMEM = 5, FIO_STATUS_PCI_UNSUPPORTED = 6, FIO_STATUS_DRIVER_LOADED = 7,
  FIO_STATUS_INVALID_INPUT = 8
}
 

Results of a data item lookup on a device.

More...

Define Documentation

#define DllExport

Typedef Documentation

typedef void(* fio_cb_fn_t)(uint64_t id, int16_t percent, void *context)

Callback function for receiving progress updates.

Parameters:
id identifier passed in when calling original operation.
percent percent complete ranging from 0 to 100.
context user context data.

Firmware version information.

Firmware version.

PCIe dynamic information that may change during operation.

typedef struct fio_pci_info fio_pci_info_t

"Static" PCI information for the device

Struct containing 'static' PCIexpress info, that should not change during operation.

structure used to register for callbacks from the SDK. All operations will block until they are complete, so the only way to tell how far along they are is to register with callbacks via this structure


Enumeration Type Documentation

Enumeration of compatibility levels a slot and card may have.

Enumerator:
COMPATIBILITY_INCOMPATIBLE 

Insufficient to run.

COMPATIBILITY_SUBOPTIMAL 

Sufficient to run, but with possibly degraded performance.

COMPATIBILITY_OPTIMAL 

The slot is providing sufficient for maximum performance.

COMPATIBILITY_UNKNOWN 

Compatibility is unknown, due to missing information.

Possible speeds that a PCIe link may have, in Gbits per second.

Enumerator:
FIO_PCIE_LINKSPEED_UNAVAIL 

PCIe link speed is unavailable

FIO_PCIE_LINKSPEED_2_5 

PCIe link speed is 2.5 Gbits/sec per lane

FIO_PCIE_LINKSPEED_5_0 

PCIe link speed is 5.0 Gbits/sec per lane

Results of a data item lookup on a device.

Enumerator:
FIO_STATUS_SUCCESS 

Success

FIO_STATUS_DEVICE_NOT_FOUND 

Couldn't find the specified device

FIO_STATUS_FAILURE 

Driver couldn't get the value

FIO_STATUS_FAILURE_PERM 

User did not have permission to get the value

FIO_STATUS_NOT_IMPLEMENTED 

Reserved for internal use.

FIO_STATUS_ENOMEM 

Out of memory while executing SDK function.

FIO_STATUS_PCI_UNSUPPORTED 

Operation using PCI selector modes not supported on the current platform.

FIO_STATUS_DRIVER_LOADED 

Unsupported operation when the driver is loaded.

FIO_STATUS_INVALID_INPUT 

Invalid input parameters.

Generated on Sun Oct 24 15:03:00 2010 for Fusion-io Device Management Public SDK by  doxygen 1.6.3