X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=8a51f728dd615612d3ada75eac9d1a80d1c2f7fb;hb=589a10135a5b811e16bdbc73b276d13884c27fa4;hp=68f8ce8e498ecce1a9df21ad91897774620c1a6c;hpb=8bfdc8c4a5fc4bee4b59838bd57c6762ea0cb206;p=libsigrok.git diff --git a/libsigrok.h b/libsigrok.h index 68f8ce8e..8a51f728 100644 --- a/libsigrok.h +++ b/libsigrok.h @@ -145,6 +145,13 @@ enum { SR_MQ_TEMPERATURE, SR_MQ_FREQUENCY, SR_MQ_DUTY_CYCLE, + SR_MQ_CONTINUITY, + SR_MQ_PULSE_WIDTH, + SR_MQ_CONDUCTANCE, + /** For a measurement of electrical power, usually in W, or dBm */ + SR_MQ_POWER, + /** Usually for measuring a transistor's gain, or h_FE*/ + SR_MQ_GAIN, }; /* sr_datafeed_analog.unit values */ @@ -153,12 +160,50 @@ enum { SR_UNIT_AMPERE, SR_UNIT_OHM, SR_UNIT_FARAD, - SR_UNIT_CELSIUS, SR_UNIT_KELVIN, + SR_UNIT_CELSIUS, + SR_UNIT_FAHRENHEIT, SR_UNIT_HERTZ, SR_UNIT_PERCENTAGE, + SR_UNIT_BOOLEAN, + SR_UNIT_SECOND, + /** Unit of conductance, the inverse of resistance. */ + SR_UNIT_SIEMENS, + /** An absolute measurement of power, in decibels, referenced to + * 1 milliwatt (dBu). */ + SR_UNIT_DECIBEL_MW, + /** Voltage in decibel, referenced to 1 volt (dBV). */ + SR_UNIT_DECIBEL_VOLT, + /** Measurements that intrinsically do not have units attached, such + * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is + * a unitless quantity. */ + SR_UNIT_UNITLESS, +}; + +/** sr_datafeed_analog.flags values */ +enum { + /** Voltage measurement is alternating current. */ + SR_MQFLAG_AC = 0x01, + /** Voltage measurement is direct current. */ + SR_MQFLAG_DC = 0x02, + /** This is a true RMS measurement. */ + SR_MQFLAG_RMS = 0x04, + /** Value is voltage drop across a diode, or NAN. */ + SR_MQFLAG_DIODE = 0x08, + /** Device is in "hold" mode, i.e. repeating the last measurement. */ + SR_MQFLAG_HOLD = 0x10, + /** Device is in "max" mode, only updating when a new max value is found. */ + SR_MQFLAG_MAX = 0x20, + /** Device is in "min" mode, only updating when a new min value is found. */ + SR_MQFLAG_MIN = 0x40, + /** Device is in autoranging mode. */ + SR_MQFLAG_AUTORANGE = 0x80, + /** Device is in relative mode. */ + SR_MQFLAG_RELATIVE = 0x100, }; +struct sr_context; + struct sr_datafeed_packet { uint16_t type; void *payload; @@ -186,15 +231,19 @@ struct sr_datafeed_meta_analog { struct sr_datafeed_analog { int num_samples; - int mq; /* Measured quantity (e.g. voltage, current, temperature) */ - int unit; /* Unit in which the MQ is measured. */ + /** Measured quantity (e.g. voltage, current, temperature) */ + int mq; + /** Unit in which the MQ is measured. */ + int unit; + /** Bitmap with extra information about the MQ. */ + uint64_t mqflags; float *data; }; struct sr_input { struct sr_input_format *format; GHashTable *param; - struct sr_dev *vdev; + struct sr_dev_inst *sdi; void *internal; }; @@ -208,7 +257,7 @@ struct sr_input_format { struct sr_output { struct sr_output_format *format; - struct sr_dev *dev; + struct sr_dev_inst *sdi; char *param; void *internal; }; @@ -223,6 +272,9 @@ struct sr_output_format { uint64_t *length_out); int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, uint64_t *length_out); + GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi, + struct sr_datafeed_packet *packet); + int (*cleanup) (struct sr_output *o); }; struct sr_datastore { @@ -251,6 +303,7 @@ struct sr_dev { enum { SR_PROBE_LOGIC, + SR_PROBE_ANALOG, }; struct sr_probe { @@ -270,13 +323,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 + * .
(decimal, e.g. 1.65) or . + * (hexadecimal, e.g. 1d6b.0001). */ SR_HWOPT_CONN, - /** Serial communication spec: e.g. 8n1 */ + /** Serial communication specification, in the form: + * / 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, }; @@ -304,10 +366,6 @@ enum { /** The device supports setting/changing its samplerate. */ SR_HWCAP_SAMPLERATE, - /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ - /** The device supports setting a probe mask. */ - SR_HWCAP_PROBECONFIG, - /** The device supports setting a pre/post-trigger capture ratio. */ SR_HWCAP_CAPTURE_RATIO, @@ -398,6 +456,7 @@ struct sr_hwcap_option { }; struct sr_dev_inst { + struct sr_dev_driver *driver; int index; int status; int inst_type; @@ -434,8 +493,10 @@ enum { /* Device info IDs */ enum { - /* struct sr_dev_inst for this specific device */ - SR_DI_INST, + /* A list of options supported by the driver. */ + SR_DI_HWOPTS, + /* A list of capabilities supported by the device. */ + SR_DI_HWCAPS, /* The number of probes connected to this device */ SR_DI_NUM_PROBES, /* The probe names on this device */ @@ -482,19 +543,23 @@ struct sr_dev_driver { int (*init) (void); int (*cleanup) (void); GSList *(*scan) (GSList *options); + GSList *(*dev_list) (void); + int (*dev_clear) (void); /* Device-specific */ - int (*dev_open) (int dev_index); - int (*dev_close) (int dev_index); - const void *(*dev_info_get) (int dev_index, int dev_info_id); - int (*dev_status_get) (int dev_index); - const int *(*hwcap_get_all) (void); - int (*dev_config_set) (int dev_index, int hwcap, const void *value); - int (*dev_acquisition_start) (int dev_index, void *session_dev_id); - int (*dev_acquisition_stop) (int dev_index, void *session_dev_id); + int (*dev_open) (struct sr_dev_inst *sdi); + int (*dev_close) (struct sr_dev_inst *sdi); + int (*info_get) (int info_id, const void **data, + const struct sr_dev_inst *sdi); + int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap, + const void *value); + int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, + void *cb_data); + int (*dev_acquisition_stop) (const struct sr_dev_inst *sdi, + void *cb_data); /* Dynamic */ - GSList *instances; + void *priv; }; struct sr_session { @@ -503,7 +568,6 @@ struct sr_session { /* list of sr_receive_data_callback_t */ GSList *datafeed_callbacks; GTimeVal starttime; - gboolean running; unsigned int num_sources;