ezusb.c: Coding style fixes.

[libsigrok.git] / sigrok.h

diff --git a/sigrok.h b/sigrok.h
index cf5cb61f2dd1e18be897551611233f9550744c07..f5678e7603a293b310bb8178896d9868770ed7ec 100644 (file)
--- a/sigrok.h
+++ b/sigrok.h
@@ -27,11 +27,27 @@
 #include <glib.h>
 #include <libusb.h>
 
-/* 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)
@@ -99,7 +115,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,
@@ -111,6 +127,8 @@ 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 {
@@ -378,5 +396,10 @@ int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 int ezusb_install_firmware(libusb_device_handle *hdl, 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