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

add SR_HWOPT_* documentation

This commit is contained in:
Bert Vermeulen 2012-10-18 22:43:03 +02:00
parent fe31f8b9f9
commit 777bbd5b98
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
libsigrok.h
View File

@ -321,13 +321,22 @@ struct sr_hwopt {
enum {
SR_HWOPT_DUMMY = 0, /* Used to terminate lists. Must be 0! */
/** Some drivers cannot detect the exact model they're talking to. */
/** Some drivers cannot detect the exact model they're talking to
* (may be phased out). */
SR_HWOPT_MODEL,
/** Specification on how to connect to a device */
/** Specification on how to connect to a device. In combination
* with SR_HWOPT_SERIALCOMM, this is a serial port in the form
* which makes sense to the operating system (/dev/ttyS0).
* Otherwise this specifies a USB device, either in the form of
* <bus>.<address> (decimal, e.g. 1.65) or <vendorid>.<productid>
* (hexadecimal, e.g. 1d6b.0001). */
SR_HWOPT_CONN,
/** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */
/** Serial communication specification, in the form:
* <speed>/<data bits><parity><stop bit> e.g.9600/ 8n1
* This is always an optional parameter, since a driver typically
* knows the speed at which the device wants to communicate */
SR_HWOPT_SERIALCOMM,
};