X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=78f1567ca775e7a8621a80e305934000fc6e283f;hb=2aebf78d9d10eb838b2fe58683d7af06015cd214;hp=3729a43c36ae042c6bd94f6db00ce6dee6100a27;hpb=a1bb33afbde769156ad4bef7a60579da64aebbb7;p=libsigrok.git diff --git a/sigrok.h b/sigrok.h index 3729a43c..78f1567c 100644 --- a/sigrok.h +++ b/sigrok.h @@ -27,16 +27,36 @@ #include #include -/* Returned status/error codes */ -#define SIGROK_STATUS_DISABLED 0 -#define SIGROK_OK 1 -#define SIGROK_NOK 2 -#define SIGROK_ERR_BADVALUE 20 +/* + * Status/error codes returned by libsigrok functions. + * + * All possible return codes of libsigrok functions must be listed here. + * Functions should never return hardcoded numbers as status, but rather + * use these #defines instead. All error codes are negative numbers. + * + * The error codes are globally unique in libsigrok, i.e. if one of the + * libsigrok functions returns a "malloc error" it must be exactly the same + * return value as used by all other functions to indicate "malloc error". + * There must be no functions which indicate two different errors via the + * same return code. + * + * Also, for compatibility reasons, no defined return codes are ever removed + * or reused for different #defines later. You can only add new #defines and + * return codes, but never remove or redefine existing ones. + */ +#define SIGROK_OK 0 /* No error */ +#define SIGROK_ERR -1 /* Generic/unspecified error */ +#define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ +#define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */ /* Handy little macros */ -#define KHZ(n) (n * 1000) -#define MHZ(n) (n * 1000000) -#define GHZ(n) (n * 1000000000) +#define KHZ(n) ((n) * 1000) +#define MHZ(n) ((n) * 1000000) +#define GHZ(n) ((n) * 1000000000) + +#ifndef ARRAY_SIZE +#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) +#endif /* Data types, used by hardware plugins for set_configuration() */ enum { @@ -56,7 +76,7 @@ struct protocol { }; /* - * datafeed + * Datafeed */ /* datafeed_packet.type values */ @@ -81,13 +101,32 @@ struct datafeed_packet { struct datafeed_header { int feed_version; struct timeval starttime; - uint64_t rate; + uint64_t samplerate; int protocol_id; int num_probes; }; /* - * output + * Input + */ +struct input { + struct input_format *format; + void *param; + void *internal; +}; + +struct input_format { + char *extension; + char *description; + int (*format_match) (char *filename); + int (*in_loadfile) (char *filename); +}; + +struct input_format **input_list(void); + + +/* + * Output */ struct output { struct output_format *format; @@ -99,7 +138,7 @@ struct output { struct output_format { char *extension; char *description; - void (*init) (struct output *o); + int (*init) (struct output *o); int (*data) (struct output *o, char *data_in, uint64_t length_in, char **data_out, uint64_t *length_out); int (*event) (struct output *o, int event_type, char **data_out, @@ -107,10 +146,14 @@ struct output_format { }; struct output_format **output_list(void); + + int filter_probes(int in_unitsize, int out_unitsize, int *probelist, char *data_in, uint64_t length_in, char **data_out, uint64_t *length_out); +char *sigrok_samplerate_string(uint64_t samplerate); + /*--- analyzer.c ------------------------------------------------------------*/ struct analyzer { @@ -135,12 +178,12 @@ void sigrok_cleanup(void); struct datastore { /* Size in bytes of the number of units stored in this datastore */ int ds_unitsize; - unsigned int num_units; + unsigned int num_units; /* TODO: uint64_t */ GSList *chunklist; }; -struct datastore *datastore_new(int unitsize); -void datastore_destroy(struct datastore *ds); +int datastore_new(int unitsize, struct datastore **ds); +int datastore_destroy(struct datastore *ds); void datastore_put(struct datastore *ds, void *data, unsigned int length, int in_unitsize, int *probelist); @@ -179,7 +222,7 @@ extern GSList *devices; void device_scan(void); void device_close_all(void); GSList *device_list(void); -struct device *device_new(struct device_plugin *plugin, int plugin_index); +struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes); void device_clear(struct device *device); void device_destroy(struct device *dev); @@ -195,13 +238,13 @@ void device_trigger_set(struct device *device, int probenum, char *trigger); /* Hardware plugin capabilities */ enum { - HWCAP_DUMMY, // used to terminate lists + HWCAP_DUMMY, /* Used to terminate lists */ HWCAP_LOGIC_ANALYZER, - HWCAP_SAMPLERATE, // change sample rate - HWCAP_PROBECONFIG, // configure probe mask - HWCAP_CAPTURE_RATIO, // set pre-trigger / post-trigger ratio - HWCAP_LIMIT_MSEC, // set a time limit for sample acquisition - HWCAP_LIMIT_SAMPLES, // set a limit on number of samples + HWCAP_SAMPLERATE, /* Change samplerate */ + HWCAP_PROBECONFIG, /* Configure probe mask */ + HWCAP_CAPTURE_RATIO, /* Set pre-trigger / post-trigger ratio */ + HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */ + HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */ }; struct hwcap_option { @@ -263,16 +306,17 @@ enum { DI_INSTANCE, /* The number of probes connected to this device */ DI_NUM_PROBES, - /* Sample rates supported by this device, (struct samplerates) */ + /* Samplerates supported by this device, (struct samplerates) */ DI_SAMPLERATES, /* Types of trigger supported, out of "01crf" (char *) */ DI_TRIGGER_TYPES, - /* The currently set sample rate in Hz (uint64_t) */ - DI_CUR_SAMPLE_RATE, + /* The currently set samplerate in Hz (uint64_t) */ + DI_CUR_SAMPLERATE, }; -/* a device supports either a range of samplerates with steps of a given - * granularity, or is limited to a set of defined samplerates. use either +/* + * A device supports either a range of samplerates with steps of a given + * granularity, or is limited to a set of defined samplerates. Use either * step or list, but not both. */ struct samplerates { @@ -283,13 +327,13 @@ struct samplerates { }; struct device_plugin { - /* plugin-specific */ + /* Plugin-specific */ char *name; int api_version; int (*init) (char *deviceinfo); void (*cleanup) (void); - /* device-specific */ + /* Device-specific */ int (*open) (int device_index); void (*close) (int device_index); void *(*get_device_info) (int device_index, int device_info_id); @@ -315,7 +359,8 @@ GSList *list_hwplugins(void); /* Generic device instances */ struct sigrok_device_instance *sigrok_device_instance_new(int index, int status, char *vendor, char *model, char *version); -struct sigrok_device_instance *get_sigrok_device_instance(GSList *device_instances, int device_index); +struct sigrok_device_instance *get_sigrok_device_instance( + GSList *device_instances, int device_index); void sigrok_device_instance_free(struct sigrok_device_instance *sdi); /* USB-specific instances */ @@ -330,7 +375,8 @@ void serial_device_instance_free(struct serial_device_instance *serial); int find_hwcap(int *capabilities, int hwcap); struct hwcap_option *find_hwcap_option(int hwcap); void source_remove(int fd); -void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb, void *user_data); +void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb, + void *user_data); /*--- session.c -------------------------------------------------------------*/ @@ -345,13 +391,13 @@ struct session { GSList *devices; /* List of struct analyzer* */ GSList *analyzers; - /* datafeed callbacks */ + /* Datafeed callbacks */ GSList *datafeed_callbacks; GTimeVal starttime; }; /* Session setup */ -struct session *session_load(char *filename); +struct session *session_load(const char *filename); struct session *session_new(void); void session_destroy(void); void session_device_clear(void); @@ -376,7 +422,15 @@ int session_save(char *filename); int ezusb_reset(struct libusb_device_handle *hdl, int set_clear); int ezusb_install_firmware(libusb_device_handle *hdl, char *filename); +int ezusb_upload_firmware(libusb_device *dev, int configuration, + const char *filename); GSList *list_serial_ports(void); +int serial_open(const char *pathname, int flags); +int serial_close(int fd); +void *serial_backup_params(int fd); +void serial_restore_params(int fd, void *backup); +int serial_set_params(int fd, int speed, int bits, int parity, int stopbits, + int flowcontrol); #endif