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 sigrok_init(void);
  26 void sigrok_cleanup(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 /*--- debug.c ---------------------------------------------------------------*/
  36
  37 void hexdump(unsigned char *address, int length);
  38
  39 /*--- device.c --------------------------------------------------------------*/
  40
  41 void device_scan(void);
  42 void device_close_all(void);
  43 GSList *device_list(void);
  44 struct device *device_new(struct device_plugin *plugin, int plugin_index,
  45                           int num_probes);
  46 void device_clear(struct device *device);
  47 void device_destroy(struct device *dev);
  48
  49 void device_probe_clear(struct device *device, int probenum);
  50 void device_probe_add(struct device *device, char *name);
  51 struct probe *probe_find(struct device *device, int probenum);
  52 void device_probe_name(struct device *device, int probenum, char *name);
  53
  54 void device_trigger_clear(struct device *device);
  55 void device_trigger_set(struct device *device, int probenum, char *trigger);
  56
  57 /*--- filter.c --------------------------------------------------------------*/
  58
  59 int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
  60                   char *data_in, uint64_t length_in, char **data_out,
  61                   uint64_t *length_out);
  62
  63 /*--- hwplugin.c ------------------------------------------------------------*/
  64
  65 int load_hwplugins(void);
  66 GSList *list_hwplugins(void);
  67
  68 /* Generic device instances */
  69 struct sigrok_device_instance *sigrok_device_instance_new(int index,
  70        int status, const char *vendor, const char *model, const char *version);
  71 struct sigrok_device_instance *get_sigrok_device_instance(
  72                         GSList *device_instances, int device_index);
  73 void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
  74
  75 /* USB-specific instances */
  76 struct usb_device_instance *usb_device_instance_new(uint8_t bus,
  77                 uint8_t address, struct libusb_device_handle *hdl);
  78 void usb_device_instance_free(struct usb_device_instance *usb);
  79
  80 /* Serial-specific instances */
  81 struct serial_device_instance *serial_device_instance_new(
  82                                         const char *port, int fd);
  83 void serial_device_instance_free(struct serial_device_instance *serial);
  84
  85 int find_hwcap(int *capabilities, int hwcap);
  86 struct hwcap_option *find_hwcap_option(int hwcap);
  87 void source_remove(int fd);
  88 void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
  89                 void *user_data);
  90
  91 /*--- session.c -------------------------------------------------------------*/
  92
  93 typedef void (*source_callback_remove) (int fd);
  94 typedef void (*source_callback_add) (int fd, int events, int timeout,
  95                 receive_data_callback callback, void *user_data);
  96 typedef void (*datafeed_callback) (struct device *device,
  97                                  struct datafeed_packet *packet);
  98
  99 /* Session setup */
 100 struct session *session_load(const char *filename);
 101 struct session *session_new(void);
 102 void session_destroy(void);
 103 void session_device_clear(void);
 104 int session_device_add(struct device *device);
 105
 106 /* Protocol analyzers setup */
 107 void session_pa_clear(void);
 108 void session_pa_add(struct analyzer *pa);
 109
 110 /* Datafeed setup */
 111 void session_datafeed_callback_clear(void);
 112 void session_datafeed_callback_add(datafeed_callback callback);
 113
 114 /* Session control */
 115 int session_start(void);
 116 void session_stop(void);
 117 void session_bus(struct device *device, struct datafeed_packet *packet);
 118 void make_metadata(char *filename);
 119 int session_save(char *filename);
 120
 121 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 122
 123 int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 124 int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
 125 int ezusb_upload_firmware(libusb_device *dev, int configuration,
 126                           const char *filename);
 127
 128 /*--- hardware/common/misc.c ------------------------------------------------*/
 129
 130 /* TODO: Should not be public. */
 131 int opendev2(int device_index, struct sigrok_device_instance **sdi,
 132              libusb_device *dev, struct libusb_device_descriptor *des,
 133              int *skip, uint16_t vid, uint16_t pid, int interface);
 134 int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
 135              struct libusb_device_descriptor *des,
 136              uint16_t vid, uint16_t pid, int interface);
 137
 138 /*--- input/input.c ---------------------------------------------------------*/
 139
 140 struct input_format **input_list(void);
 141
 142 /*--- output/output.c -------------------------------------------------------*/
 143
 144 struct output_format **output_list(void);
 145
 146 /*--- output/common.c -------------------------------------------------------*/
 147
 148 char *sigrok_samplerate_string(uint64_t samplerate);
 149 char *sigrok_period_string(uint64_t frequency);
 150
 151 #endif