![]() |
libsigrok
0.3.0
sigrok hardware access and backend library
|
Hardware driver handling in libsigrok. More...
Functions | |
struct sr_dev_driver ** | sr_driver_list (void) |
Return the list of supported hardware drivers. More... | |
int | sr_driver_init (struct sr_context *ctx, struct sr_dev_driver *driver) |
Initialize a hardware driver. More... | |
GSList * | sr_driver_scan (struct sr_dev_driver *driver, GSList *options) |
Tell a hardware driver to scan for devices. More... | |
int | sr_config_get (const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, int key, GVariant **data) |
Query value of a configuration key at the given driver or device instance. More... | |
int | sr_config_set (const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, int key, GVariant *data) |
Set value of a configuration key in a device instance. More... | |
int | sr_config_commit (const struct sr_dev_inst *sdi) |
Apply configuration settings to the device hardware. More... | |
int | sr_config_list (const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, int key, GVariant **data) |
List all possible values for a configuration key. More... | |
const struct sr_config_info * | sr_config_info_get (int key) |
Get information about a configuration key, by key. More... | |
const struct sr_config_info * | sr_config_info_name_get (const char *optname) |
Get information about a configuration key, by name. More... | |
Hardware driver handling in libsigrok.
int sr_config_commit | ( | const struct sr_dev_inst * | sdi | ) |
Apply configuration settings to the device hardware.
sdi | The device instance. |
Definition at line 679 of file hwdriver.c.
References sr_dev_driver::config_commit, sr_dev_inst::driver, SR_ERR, and SR_OK.
Referenced by sr_session_dev_add(), and sr_session_start().
int sr_config_get | ( | const struct sr_dev_driver * | driver, |
const struct sr_dev_inst * | sdi, | ||
const struct sr_channel_group * | cg, | ||
int | key, | ||
GVariant ** | data | ||
) |
Query value of a configuration key at the given driver or device instance.
[in] | driver | The sr_dev_driver struct to query. |
[in] | sdi | (optional) If the key is specific to a device, this must contain a pointer to the struct sr_dev_inst to be checked. Otherwise it must be NULL. |
[in] | cg | The channel group on the device for which to list the values, or NULL. |
[in] | key | The configuration key (SR_CONF_*). |
[in,out] | data | Pointer to a GVariant where the value will be stored. Must not be NULL. The caller is given ownership of the GVariant and must thus decrease the refcount after use. However if this function returns an error code, the field should be considered unused, and should not be unreferenced. |
SR_OK | Success. |
SR_ERR | Error. |
SR_ERR_ARG | The driver doesn't know that key, but this is not to be interpreted as an error by the caller; merely as an indication that it's not applicable. |
Definition at line 609 of file hwdriver.c.
References sr_dev_driver::config_get, SR_ERR, SR_ERR_ARG, and SR_OK.
Referenced by sr_session_save().
const struct sr_config_info* sr_config_info_get | ( | int | key | ) |
Get information about a configuration key, by key.
[in] | key | The configuration key. |
Definition at line 743 of file hwdriver.c.
References sr_config_info::key.
const struct sr_config_info* sr_config_info_name_get | ( | const char * | optname | ) |
Get information about a configuration key, by name.
[in] | optname | The configuration key. |
Definition at line 765 of file hwdriver.c.
References sr_config_info::key.
int sr_config_list | ( | const struct sr_dev_driver * | driver, |
const struct sr_dev_inst * | sdi, | ||
const struct sr_channel_group * | cg, | ||
int | key, | ||
GVariant ** | data | ||
) |
List all possible values for a configuration key.
[in] | driver | The sr_dev_driver struct to query. |
[in] | sdi | (optional) If the key is specific to a device, this must contain a pointer to the struct sr_dev_inst to be checked. |
[in] | cg | The channel group on the device for which to list the values, or NULL. |
[in] | key | The configuration key (SR_CONF_*). |
[in,out] | data | A pointer to a GVariant where the list will be stored. The caller is given ownership of the GVariant and must thus unref the GVariant after use. However if this function returns an error code, the field should be considered unused, and should not be unreferenced. |
SR_OK | Success. |
SR_ERR | Error. |
SR_ERR_ARG | The driver doesn't know that key, but this is not to be interpreted as an error by the caller; merely as an indication that it's not applicable. |
Definition at line 716 of file hwdriver.c.
References sr_dev_driver::config_list, SR_ERR, SR_ERR_ARG, and SR_OK.
int sr_config_set | ( | const struct sr_dev_inst * | sdi, |
const struct sr_channel_group * | cg, | ||
int | key, | ||
GVariant * | data | ||
) |
Set value of a configuration key in a device instance.
[in] | sdi | The device instance. |
[in] | cg | The channel group on the device for which to list the values, or NULL. |
[in] | key | The configuration key (SR_CONF_*). |
data | The new value for the key, as a GVariant with GVariantType appropriate to that key. A floating reference can be passed in; its refcount will be sunk and unreferenced after use. |
SR_OK | Success. |
SR_ERR | Error. |
SR_ERR_ARG | The driver doesn't know that key, but this is not to be interpreted as an error by the caller; merely as an indication that it's not applicable. |
Definition at line 650 of file hwdriver.c.
References sr_dev_driver::config_set, sr_dev_inst::driver, SR_ERR, and SR_ERR_ARG.
int sr_driver_init | ( | struct sr_context * | ctx, |
struct sr_dev_driver * | driver | ||
) |
Initialize a hardware driver.
This usually involves memory allocations and variable initializations within the driver, but not scanning for attached devices. The API call sr_driver_scan() is used for that.
ctx | A libsigrok context object allocated by a previous call to sr_init(). Must not be NULL. |
driver | The driver to initialize. This must be a pointer to one of the entries returned by sr_driver_list(). Must not be NULL. |
SR_OK | Success |
SR_ERR_ARG | Invalid parameter(s). |
SR_ERR_BUG | Internal errors. |
other | Another negative error code upon other errors. |
Definition at line 471 of file hwdriver.c.
References sr_dev_driver::init, sr_dev_driver::name, and SR_ERR_ARG.
struct sr_dev_driver** sr_driver_list | ( | void | ) |
Return the list of supported hardware drivers.
Definition at line 446 of file hwdriver.c.
GSList* sr_driver_scan | ( | struct sr_dev_driver * | driver, |
GSList * | options | ||
) |
Tell a hardware driver to scan for devices.
In addition to the detection, the devices that are found are also initialized automatically. On some devices, this involves a firmware upload, or other such measures.
The order in which the system is scanned for devices is not specified. The caller should not assume or rely on any specific order.
Before calling sr_driver_scan(), the user must have previously initialized the driver by calling sr_driver_init().
driver | The driver that should scan. This must be a pointer to one of the entries returned by sr_driver_list(). Must not be NULL. |
options | A list of 'struct sr_hwopt' options to pass to the driver's scanner. Can be NULL/empty. |
Definition at line 517 of file hwdriver.c.
References sr_dev_driver::name, sr_dev_driver::priv, and sr_dev_driver::scan.