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 sr_datastore_new(int unitsize, struct sr_datastore **ds);
  31 int sr_datastore_destroy(struct sr_datastore *ds);
  32 void sr_datastore_put(struct sr_datastore *ds, void *data, unsigned int length,
  33                       int in_unitsize, int *probelist);
  34
  35 /*--- device.c --------------------------------------------------------------*/
  36
  37 void sr_device_scan(void);
  38 int sr_device_plugin_init(struct sr_device_plugin *plugin);
  39 void sr_device_close_all(void);
  40 GSList *sr_device_list(void);
  41 struct sr_device *sr_device_new(struct sr_device_plugin *plugin,
  42                                 int plugin_index, int num_probes);
  43 void sr_device_clear(struct sr_device *device);
  44 void sr_device_destroy(struct sr_device *dev);
  45
  46 void sr_device_probe_clear(struct sr_device *device, int probenum);
  47 void sr_device_probe_add(struct sr_device *device, const char *name);
  48 struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum);
  49 void sr_device_probe_name(struct sr_device *device, int probenum,
  50                           const char *name);
  51
  52 void sr_device_trigger_clear(struct sr_device *device);
  53 void sr_device_trigger_set(struct sr_device *device, int probenum,
  54                            const char *trigger);
  55 gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap);
  56
  57 /*--- filter.c --------------------------------------------------------------*/
  58
  59 int sr_filter_probes(int in_unitsize, int out_unitsize, int *probelist,
  60                      const char *data_in, uint64_t length_in, char **data_out,
  61                      uint64_t *length_out);
  62
  63 /*--- hwplugin.c ------------------------------------------------------------*/
  64
  65 GSList *sr_list_hwplugins(void);
  66
  67 /* Generic device instances */
  68 struct sr_device_instance *sr_device_instance_new(int index,
  69        int status, const char *vendor, const char *model, const char *version);
  70 struct sr_device_instance *sr_get_device_instance(GSList *device_instances,
  71                                                   int device_index);
  72 void sr_device_instance_free(struct sr_device_instance *sdi);
  73
  74 /* USB-specific instances */
  75 #ifdef HAVE_LIBUSB_1_0
  76 struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
  77                 uint8_t address, struct libusb_device_handle *hdl);
  78 void sr_usb_device_instance_free(struct sr_usb_device_instance *usb);
  79 #endif
  80
  81 /* Serial-specific instances */
  82 struct sr_serial_device_instance *sr_serial_device_instance_new(
  83                                         const char *port, int fd);
  84 void sr_serial_device_instance_free(struct sr_serial_device_instance *serial);
  85
  86 int sr_find_hwcap(int *capabilities, int hwcap);
  87 struct sr_hwcap_option *sr_find_hwcap_option(int hwcap);
  88 void sr_source_remove(int fd);
  89 void sr_source_add(int fd, int events, int timeout,
  90                    receive_data_callback rcv_cb, void *user_data);
  91
  92 /*--- session.c -------------------------------------------------------------*/
  93
  94 typedef void (*source_callback_remove) (int fd);
  95 typedef void (*source_callback_add) (int fd, int events, int timeout,
  96                 receive_data_callback callback, void *user_data);
  97 typedef void (*datafeed_callback) (struct sr_device *device,
  98                                  struct sr_datafeed_packet *packet);
  99
 100 /* Session setup */
 101 int sr_session_load(const char *filename);
 102 struct sr_session *sr_session_new(void);
 103 void sr_session_destroy(void);
 104 void sr_session_device_clear(void);
 105 int sr_session_device_add(struct sr_device *device);
 106
 107 /* Protocol analyzers setup */
 108 void sr_session_pa_clear(void);
 109 void sr_session_pa_add(struct analyzer *pa);
 110
 111 /* Datafeed setup */
 112 void sr_session_datafeed_callback_clear(void);
 113 void sr_session_datafeed_callback_add(datafeed_callback callback);
 114
 115 /* Session control */
 116 int sr_session_start(void);
 117 void sr_session_run(void);
 118 void sr_session_halt(void);
 119 void sr_session_stop(void);
 120 void sr_session_bus(struct sr_device *device,
 121                     struct sr_datafeed_packet *packet);
 122 int sr_session_save(const char *filename);
 123 void sr_session_source_add(int fd, int events, int timeout,
 124                 receive_data_callback callback, void *user_data);
 125 void sr_session_source_remove(int fd);
 126
 127 /*--- input/input.c ---------------------------------------------------------*/
 128
 129 struct sr_input_format **sr_input_list(void);
 130
 131 /*--- output/output.c -------------------------------------------------------*/
 132
 133 struct sr_output_format **sr_output_list(void);
 134
 135 /*--- output/common.c -------------------------------------------------------*/
 136
 137 char *sr_samplerate_string(uint64_t samplerate);
 138 char *sr_period_string(uint64_t frequency);
 139 char **sr_parse_triggerstring(struct sr_device *device,
 140                               const char *triggerstring);
 141 uint64_t sr_parse_sizestring(const char *sizestring);
 142 uint64_t sr_parse_timestring(const char *timestring);
 143
 144 #endif