sigrok-proto.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef SIGROK_SIGROK_PROTO_H
  21 #define SIGROK_SIGROK_PROTO_H
  22
  23 /*--- backend.c -------------------------------------------------------------*/
  24
  25 int sr_init(void);
  26 void sr_exit(void);
  27
  28 /*--- datastore.c -----------------------------------------------------------*/
  29
  30 int datastore_new(int unitsize, struct datastore **ds);
  31 int datastore_destroy(struct datastore *ds);
  32 void datastore_put(struct datastore *ds, void *data, unsigned int length,
  33                    int in_unitsize, int *probelist);
  34
  35 /*--- device.c --------------------------------------------------------------*/
  36
  37 void device_scan(void);
  38 int device_plugin_init(struct sr_device_plugin *plugin);
  39 void device_close_all(void);
  40 GSList *device_list(void);
  41 struct sr_device *device_new(struct sr_device_plugin *plugin, int plugin_index,
  42                              int num_probes);
  43 void device_clear(struct sr_device *device);
  44 void device_destroy(struct sr_device *dev);
  45
  46 void device_probe_clear(struct sr_device *device, int probenum);
  47 void device_probe_add(struct sr_device *device, char *name);
  48 struct probe *probe_find(struct sr_device *device, int probenum);
  49 void device_probe_name(struct sr_device *device, int probenum, char *name);
  50
  51 void device_trigger_clear(struct sr_device *device);
  52 void device_trigger_set(struct sr_device *device, int probenum, char *trigger);
  53 gboolean device_has_hwcap(struct sr_device *device, int hwcap);
  54
  55 /*--- filter.c --------------------------------------------------------------*/
  56
  57 int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
  58                   char *data_in, uint64_t length_in, char **data_out,
  59                   uint64_t *length_out);
  60
  61 /*--- hwplugin.c ------------------------------------------------------------*/
  62
  63 int load_hwplugins(void);
  64 GSList *list_hwplugins(void);
  65
  66 /* Generic device instances */
  67 struct sr_device_instance *sr_device_instance_new(int index,
  68        int status, const char *vendor, const char *model, const char *version);
  69 struct sr_device_instance *sr_get_device_instance(GSList *device_instances,
  70                                                   int device_index);
  71 void sr_device_instance_free(struct sr_device_instance *sdi);
  72
  73 /* USB-specific instances */
  74 struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
  75                 uint8_t address, struct libusb_device_handle *hdl);
  76 void sr_usb_device_instance_free(struct sr_usb_device_instance *usb);
  77
  78 /* Serial-specific instances */
  79 struct sr_serial_device_instance *sr_serial_device_instance_new(
  80                                         const char *port, int fd);
  81 void sr_serial_device_instance_free(struct sr_serial_device_instance *serial);
  82
  83 int find_hwcap(int *capabilities, int hwcap);
  84 struct hwcap_option *find_hwcap_option(int hwcap);
  85 void source_remove(int fd);
  86 void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
  87                 void *user_data);
  88
  89 /*--- session.c -------------------------------------------------------------*/
  90
  91 typedef void (*source_callback_remove) (int fd);
  92 typedef void (*source_callback_add) (int fd, int events, int timeout,
  93                 receive_data_callback callback, void *user_data);
  94 typedef void (*datafeed_callback) (struct sr_device *device,
  95                                  struct sr_datafeed_packet *packet);
  96
  97 /* Session setup */
  98 int session_load(const char *filename);
  99 struct session *session_new(void);
 100 void session_destroy(void);
 101 void session_device_clear(void);
 102 int session_device_add(struct sr_device *device);
 103
 104 /* Protocol analyzers setup */
 105 void session_pa_clear(void);
 106 void session_pa_add(struct analyzer *pa);
 107
 108 /* Datafeed setup */
 109 void session_datafeed_callback_clear(void);
 110 void session_datafeed_callback_add(datafeed_callback callback);
 111
 112 /* Session control */
 113 int session_start(void);
 114 void session_run(void);
 115 void session_halt(void);
 116 void session_stop(void);
 117 void session_bus(struct sr_device *device, struct sr_datafeed_packet *packet);
 118 void make_metadata(char *filename);
 119 int session_save(char *filename);
 120 void session_source_add(int fd, int events, int timeout,
 121                 receive_data_callback callback, void *user_data);
 122 void session_source_remove(int fd);
 123
 124 /*--- input/input.c ---------------------------------------------------------*/
 125
 126 struct sr_input_format **sr_input_list(void);
 127
 128 /*--- output/output.c -------------------------------------------------------*/
 129
 130 struct sr_output_format **sr_output_list(void);
 131
 132 /*--- output/common.c -------------------------------------------------------*/
 133
 134 char *sr_samplerate_string(uint64_t samplerate);
 135 char *sr_period_string(uint64_t frequency);
 136 char **sr_parse_triggerstring(struct sr_device *device, const char *triggerstring);
 137 uint64_t sr_parse_sizestring(const char *sizestring);
 138 uint64_t sr_parse_timestring(const char *timestring);
 139
 140 #endif