#include <fio/public/iodimm_types.h>
Go to the source code of this file.
Functions | |
DllExport int | fio_sdk_init (uint32_t api_version) |
Initialize the SDK. This must be done before beginning to use the SDK's functionality, in order to guarantee proper behavior. | |
DllExport void | fio_sdk_fini (void) |
Shutdown the SDK. This should be done prior to exiting your application to assure that all internally opened handles are closed. | |
DllExport fio_iodimm_attach_status_t | fio_attach_iodimm2 (fio_iodimm_selector_t *device, fio_iodimm_attach_req2_t *request, fio_progress_callback2_t *callback) |
Attach the ioDimm to allow it to function as a block device. This function is thread-safe and may be called on multiple ioDimm's in parallel. | |
DllExport fio_iodimm_detach_status_t | fio_detach_iodimm2 (fio_iodimm_selector_t *device, fio_iodimm_detach_req2_t *request, fio_progress_callback2_t *callback) |
Detach the iodrive to allow operations such as low-level format. This function is thread-safe and may be called on multiple ioDimm's in parallel. | |
DllExport fio_iodimm_update_status_t | fio_update_iodimm_firmware2 (fio_iodimm_selector_t *device, fio_iodimm_update_req2_t *request, fio_progress_callback2_t *callback) |
Update the ioDrive firmware using the given firmware file. This function is thread-safe and may be called on multiple ioDimm's in parallel. | |
DllExport fio_iodimm_fff_ver_status_t | fio_get_fff_firmware_ver2 (fio_iodimm_selector_t *device, fio_iodimm_fff_ver_req2_t *request, fio_firmware_version_t *firmware_ver) |
Get the firmware version for the selected device in the given FFF file. This can be used to tell whether a device is up to date with respect to a given fff file. | |
DllExport uint8_t | fio_iodimm_update_get_firmware_barrier_version (fio_firmware_barrier_t *barrier) |
Get the firmware barrier version--if any--given the current firmware version. You must upgrade first to the barrier version before upgrading to the final version. This is useful to determine if one can upgrade directly from the current version to a final version. | |
DllExport fio_iodimm_format_status_t | fio_format_iodimm2 (fio_iodimm_selector_t *device, fio_iodimm_format_req2_t *request, fio_progress_callback2_t *callback) |
Perform a low-level format on the device. The device must be in a detached state. | |
DllExport fio_iodimm_prealloc_status_t | fio_set_iodimm_preallocation (fio_iodimm_selector_t *device, fio_iodimm_prealloc_req_t *request) |
Enable or disable preallocation of memory for the given ioDimm. Enabling preallocation will cause the driver to allocate worst case memory usage for this ioDimm, which will allow this ioDimm to be used as swap space. |
DllExport fio_iodimm_attach_status_t fio_attach_iodimm2 | ( | fio_iodimm_selector_t * | device, | |
fio_iodimm_attach_req2_t * | request, | |||
fio_progress_callback2_t * | callback | |||
) |
Attach the ioDimm to allow it to function as a block device. This function is thread-safe and may be called on multiple ioDimm's in parallel.
device | Device selector. See the header (iodimm_types.h) for more information on how to populate this struct. | |
request | the attach request structure (optional, may be NULL). See the header (iodimm_types.h) for more information on how to populate this struct. | |
callback | structure (optional, may be NULL). See the header (common_types.h) for more information on how to populate this struct. |
DllExport fio_iodimm_detach_status_t fio_detach_iodimm2 | ( | fio_iodimm_selector_t * | device, | |
fio_iodimm_detach_req2_t * | request, | |||
fio_progress_callback2_t * | callback | |||
) |
Detach the iodrive to allow operations such as low-level format. This function is thread-safe and may be called on multiple ioDimm's in parallel.
device | Device selector. See the header (iodimm_types.h) for more information on how to populate this struct. | |
request | the detach request structure. See the header (iodimm_types.h) for more information on how to populate this struct. * | |
callback | structure (optional, may be NULL). See the header (common_types.h) for more information on how to populate this struct. |
DllExport fio_iodimm_format_status_t fio_format_iodimm2 | ( | fio_iodimm_selector_t * | device, | |
fio_iodimm_format_req2_t * | request, | |||
fio_progress_callback2_t * | callback | |||
) |
Perform a low-level format on the device. The device must be in a detached state.
device | Device selector. See the header (iodimm_types.h) for more information on how to populate this struct. | |
request | the format request structure. See the header (iodimm_types.h) for more information on how to populate this struct. | |
callback | structure (optional, may be NULL). See the header (common_types.h) for more information on how to populate this struct. |
DllExport fio_iodimm_fff_ver_status_t fio_get_fff_firmware_ver2 | ( | fio_iodimm_selector_t * | device, | |
fio_iodimm_fff_ver_req2_t * | request, | |||
fio_firmware_version_t * | firmware_ver | |||
) |
Get the firmware version for the selected device in the given FFF file. This can be used to tell whether a device is up to date with respect to a given fff file.
device | Device selector. See the header (iodimm_types.h) for more information on how to populate this struct. | |
request | the get firmware request structure. See the header (iodimm_types.h) for more information on how to populate this struct. | |
firmware_ver | OUTPUT: an allocated structure to place the firmware version in. |
DllExport uint8_t fio_iodimm_update_get_firmware_barrier_version | ( | fio_firmware_barrier_t * | barrier | ) |
Get the firmware barrier version--if any--given the current firmware version. You must upgrade first to the barrier version before upgrading to the final version. This is useful to determine if one can upgrade directly from the current version to a final version.
barrier | IN/OUT: an allocated structure to specify the current version and to receive the barrier version. |
DllExport void fio_sdk_fini | ( | void | ) |
Shutdown the SDK. This should be done prior to exiting your application to assure that all internally opened handles are closed.
DllExport int fio_sdk_init | ( | uint32_t | api_version | ) |
Initialize the SDK. This must be done before beginning to use the SDK's functionality, in order to guarantee proper behavior.
api_version | The SDK version being used by the client of this SDK. Used internally when allocating structures to assure backward compatibility. |
DllExport fio_iodimm_prealloc_status_t fio_set_iodimm_preallocation | ( | fio_iodimm_selector_t * | device, | |
fio_iodimm_prealloc_req_t * | request | |||
) |
Enable or disable preallocation of memory for the given ioDimm. Enabling preallocation will cause the driver to allocate worst case memory usage for this ioDimm, which will allow this ioDimm to be used as swap space.
device | Device selector. See the header (iodimm_types.h) for more information on how to populate this struct. | |
request | prealloc settings. See the header (iodimm_types.h) for more information on how to populate this struct. |
DllExport fio_iodimm_update_status_t fio_update_iodimm_firmware2 | ( | fio_iodimm_selector_t * | device, | |
fio_iodimm_update_req2_t * | request, | |||
fio_progress_callback2_t * | callback | |||
) |
Update the ioDrive firmware using the given firmware file. This function is thread-safe and may be called on multiple ioDimm's in parallel.
device | Device selector. See the header (iodimm_types.h) for more information on how to populate this struct. | |
request | the update request structure. See the header (iodimm_types.h) for more information on how to populate this struct. | |
callback | structure (optional, may be NULL). See the header (common_types.h) for more information on how to populate this struct. |