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

sr: comments/docs

This commit is contained in:
Bert Vermeulen 2012-07-22 20:06:13 +02:00
parent 37e8b4c4f7
commit a5f2e70712
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
device.c
View File

@ -101,11 +101,10 @@ SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
* be silently replaced. * be silently replaced.
* *
* @param sdi Must not be NULL. * @param sdi Must not be NULL.
* @param probenum The number of the probe. * @param probenum The probe number, starting from 0.
* Note that the probe numbers start at 1 (not 0!). * @param trigger Trigger string, in the format used by sigrok-cli
* @param trigger trigger string, in the format used by sigrok-cli
* *
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
*/ */
SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
const char *trigger) const char *trigger)
@ -142,7 +141,7 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
* @param hwcap The capability that should be checked (whether it's supported * @param hwcap The capability that should be checked (whether it's supported
* by the specified device). * by the specified device).
* *
* @return TRUE, if the device has the specified capability, FALSE otherwise. * @return TRUE if the device has the specified capability, FALSE otherwise.
* FALSE is also returned upon invalid input parameters or other * FALSE is also returned upon invalid input parameters or other
* error conditions. * error conditions.
*/ */

7
hwdriver.c
View File

@ -148,6 +148,13 @@ SR_API int sr_driver_init(struct sr_dev_driver *driver)
/** /**
* Tell a hardware driver to scan for devices. * 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.
*
* @param driver The driver. * @param driver The driver.
* @param options A list of struct sr_hwopt options to pass to the driver's * @param options A list of struct sr_hwopt options to pass to the driver's
* scanner. * scanner.