X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=aec127405bdde49b13ab5a0febf316e5a1e8f020;hb=9a5c6dcf498b8dfebb8beb848ee6db6b59b173e5;hp=50fd0716ba17229988db7ebcba047e78a9a4d452;hpb=2b3414a497f639233c824bc930cecf5f17b5a79d;p=libsigrok.git

diff --git a/sigrok.h b/sigrok.h
index 50fd0716..aec12740 100644
--- a/sigrok.h
+++ b/sigrok.h
@@ -50,9 +50,13 @@
 #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 {
@@ -72,7 +76,7 @@ struct protocol {
 };
 
 /*
- * datafeed
+ * Datafeed
  */
 
 /* datafeed_packet.type values */
@@ -103,7 +107,26 @@ struct datafeed_header {
 };
 
 /*
- * 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;
@@ -123,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 {
@@ -151,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);
 
@@ -195,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);
 
@@ -211,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 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
+	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 {
@@ -287,8 +314,9 @@ enum {
 	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 {
@@ -299,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);
@@ -331,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 */
@@ -346,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 -------------------------------------------------------------*/
 
@@ -361,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);
@@ -392,7 +422,24 @@ 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);
+
+/* libsigrok/hardware/common/misc.c */
+/* TODO: Should not be public. */
+int opendev2(int device_index, struct sigrok_device_instance **sdi,
+	     libusb_device *dev, struct libusb_device_descriptor *des,
+	     int *skip, uint16_t vid, uint16_t pid, int interface);
+int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
+	     struct libusb_device_descriptor *des,
+	     uint16_t vid, uint16_t pid, int interface);
 
 #endif