BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

device: Make some parameters const.

This commit is contained in:
Uwe Hermann 2011-12-28 21:34:37 +01:00
parent 0e3b143994
commit 08d4cc1d14
2 changed files with 10 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
device.c
View File

@ -104,7 +104,6 @@ GSList *sr_device_list(void)
/** /**
* Create a new device. * Create a new device.
* *
* TODO: 'plugin' can be const.
* TODO: num_probes should be uint16_t. * TODO: num_probes should be uint16_t.
* TODO: Should return int, so that we can return SR_OK, SR_ERR_* etc. * TODO: Should return int, so that we can return SR_OK, SR_ERR_* etc.
* *
@ -119,8 +118,8 @@ GSList *sr_device_list(void)
* *
* @return Pointer to the newly allocated device, or NULL upon errors. * @return Pointer to the newly allocated device, or NULL upon errors.
*/ */
struct sr_device *sr_device_new(struct sr_device_plugin *plugin, int plugin_index, struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
int num_probes) int plugin_index, int num_probes)
{ {
struct sr_device *device; struct sr_device *device;
int i; int i;
@ -139,7 +138,7 @@ struct sr_device *sr_device_new(struct sr_device_plugin *plugin, int plugin_inde
return NULL; return NULL;
} }
device->plugin = plugin; device->plugin = (struct sr_device_plugin *)plugin;
device->plugin_index = plugin_index; device->plugin_index = plugin_index;
devices = g_slist_append(devices, device); devices = g_slist_append(devices, device);
@ -301,13 +300,13 @@ int sr_device_probe_add(struct sr_device *device, const char *name)
* Note that the probe numbers start at 1 (not 0!). * Note that the probe numbers start at 1 (not 0!).
* *
* TODO: Should return int. * TODO: Should return int.
* TODO: device can be const.
* TODO: probenum should be unsigned. * TODO: probenum should be unsigned.
* *
* @return A pointer to the requested probe's 'struct sr_probe', or NULL * @return A pointer to the requested probe's 'struct sr_probe', or NULL
* if the probe could not be found. * if the probe could not be found.
*/ */
struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum) struct sr_probe *sr_device_probe_find(const struct sr_device *device,
int probenum)
{ {
GSList *l; GSList *l;
struct sr_probe *p, *found_probe; struct sr_probe *p, *found_probe;
@ -338,7 +337,6 @@ struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum)
* If the probe already has a different name assigned to it, it will be * If the probe already has a different name assigned to it, it will be
* removed, and the new name will be saved instead. * removed, and the new name will be saved instead.
* *
* TODO: device can be const?
* TODO: Rename to sr_device_set_probe_name(). * TODO: Rename to sr_device_set_probe_name().
* *
* @param device TODO * @param device TODO
@ -382,8 +380,6 @@ int sr_device_probe_name(struct sr_device *device, int probenum,
* *
* TODO: Better description. * TODO: Better description.
* *
* TODO: device can be const?
*
* @param device TODO * @param device TODO
* *
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
@ -422,8 +418,6 @@ int sr_device_trigger_clear(struct sr_device *device)
* TODO: Better description. * TODO: Better description.
* TODO: Describe valid format of the 'trigger' string. * TODO: Describe valid format of the 'trigger' string.
* *
* TODO: device can be const?
*
* @param device TODO. Must not be NULL. * @param device TODO. Must not be NULL.
* @param probenum The number of the probe. TODO. * @param probenum The number of the probe. TODO.
* Note that the probe numbers start at 1 (not 0!). * Note that the probe numbers start at 1 (not 0!).
@ -467,7 +461,6 @@ int sr_device_trigger_set(struct sr_device *device, int probenum,
* Determine whether the specified device has the specified capability. * Determine whether the specified device has the specified capability.
* *
* TODO: Should return int? * TODO: Should return int?
* TODO: device can be const.
* *
* @param device Pointer to the device to be checked. Must not be NULL. * @param device Pointer to the device to be checked. Must not be NULL.
* The device's 'plugin' field must not be NULL either. * The device's 'plugin' field must not be NULL either.
@ -478,7 +471,7 @@ int sr_device_trigger_set(struct sr_device *device, int probenum,
* FALSE is also returned upon invalid input parameters or other * FALSE is also returned upon invalid input parameters or other
* error conditions. * error conditions.
*/ */
gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap) gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap)
{ {
int *capabilities, i; int *capabilities, i;

9
sigrok-proto.h
View File

@ -42,21 +42,20 @@ int sr_datastore_put(struct sr_datastore *ds, void *data, unsigned int length,
int sr_device_scan(void); int sr_device_scan(void);
int sr_init_hwplugins(struct sr_device_plugin *plugin); int sr_init_hwplugins(struct sr_device_plugin *plugin);
GSList *sr_device_list(void); GSList *sr_device_list(void);
struct sr_device *sr_device_new(struct sr_device_plugin *plugin, struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
int plugin_index, int num_probes); int plugin_index, int num_probes);
int sr_device_clear(struct sr_device *device); int sr_device_clear(struct sr_device *device);
void sr_device_destroy(struct sr_device *dev); void sr_device_destroy(struct sr_device *dev);
int sr_device_probe_clear(struct sr_device *device, int probenum); int sr_device_probe_clear(struct sr_device *device, int probenum);
int sr_device_probe_add(struct sr_device *device, const char *name); int sr_device_probe_add(struct sr_device *device, const char *name);
struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum); struct sr_probe *sr_device_probe_find(const struct sr_device *device,
int probenum);
int sr_device_probe_name(struct sr_device *device, int probenum, int sr_device_probe_name(struct sr_device *device, int probenum,
const char *name); const char *name);
int sr_device_trigger_clear(struct sr_device *device); int sr_device_trigger_clear(struct sr_device *device);
int sr_device_trigger_set(struct sr_device *device, int probenum, int sr_device_trigger_set(struct sr_device *device, int probenum,
const char *trigger); const char *trigger);
gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap); gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap);
/*--- filter.c --------------------------------------------------------------*/ /*--- filter.c --------------------------------------------------------------*/