libsigrok-internal.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 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 LIBSIGROK_SIGROK_INTERNAL_H
  21 #define LIBSIGROK_SIGROK_INTERNAL_H
  22
  23 #include <stdarg.h>
  24 #include <glib.h>
  25 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  26 #ifdef HAVE_LIBUSB_1_0
  27 #include <libusb.h>
  28 #endif
  29
  30 /*--- Macros ----------------------------------------------------------------*/
  31
  32 #ifndef ARRAY_SIZE
  33 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  34 #endif
  35
  36 #ifndef ARRAY_AND_SIZE
  37 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  38 #endif
  39
  40 /* Versions < 2.30.0 of glib don't have g_match_info_unref(). */
  41 #if !GLIB_CHECK_VERSION(2,30,0)
  42 #define g_match_info_unref g_match_info_free
  43 #endif
  44
  45 /* Size of a datastore chunk in units */
  46 #define DATASTORE_CHUNKSIZE (512 * 1024)
  47
  48 struct sr_context {
  49 #ifdef HAVE_LIBUSB_1_0
  50         libusb_context *libusb_ctx;
  51 #endif
  52 };
  53
  54 #ifdef HAVE_LIBUSB_1_0
  55 struct sr_usb_dev_inst {
  56         uint8_t bus;
  57         uint8_t address;
  58         struct libusb_device_handle *devhdl;
  59 };
  60 #endif
  61
  62 #define SERIAL_PARITY_NONE 0
  63 #define SERIAL_PARITY_EVEN 1
  64 #define SERIAL_PARITY_ODD  2
  65 struct sr_serial_dev_inst {
  66         char *port;
  67         int fd;
  68 };
  69
  70 /* Private driver context. */
  71 struct drv_context {
  72         GSList *instances;
  73 };
  74
  75 /*--- log.c -----------------------------------------------------------------*/
  76
  77 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  78 SR_PRIV int sr_spew(const char *format, ...);
  79 SR_PRIV int sr_dbg(const char *format, ...);
  80 SR_PRIV int sr_info(const char *format, ...);
  81 SR_PRIV int sr_warn(const char *format, ...);
  82 SR_PRIV int sr_err(const char *format, ...);
  83
  84 /*--- device.c --------------------------------------------------------------*/
  85
  86 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
  87                 gboolean enabled, const char *name);
  88
  89 /* Generic device instances */
  90 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
  91                 const char *vendor, const char *model, const char *version);
  92 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
  93 #ifdef HAVE_LIBUSB_1_0
  94
  95 /* USB-specific instances */
  96 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
  97                 uint8_t address, struct libusb_device_handle *hdl);
  98 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
  99 #endif
 100
 101 /* Serial-specific instances */
 102 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(
 103                                         const char *port, int fd);
 104 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 105
 106
 107 /*--- hwdriver.c ------------------------------------------------------------*/
 108
 109 SR_PRIV void sr_hw_cleanup_all(void);
 110 SR_PRIV int sr_source_remove(int fd);
 111 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 112                           sr_receive_data_callback_t cb, void *cb_data);
 113
 114 /*--- session.c -------------------------------------------------------------*/
 115
 116 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 117                             struct sr_datafeed_packet *packet);
 118
 119 /*--- hardware/common/serial.c ----------------------------------------------*/
 120
 121 SR_PRIV GSList *list_serial_ports(void);
 122 SR_PRIV int serial_open(const char *pathname, int flags);
 123 SR_PRIV int serial_close(int fd);
 124 SR_PRIV int serial_flush(int fd);
 125 SR_PRIV int serial_write(int fd, const void *buf, size_t count);
 126 SR_PRIV int serial_read(int fd, void *buf, size_t count);
 127 SR_PRIV void *serial_backup_params(int fd);
 128 SR_PRIV void serial_restore_params(int fd, void *backup);
 129 SR_PRIV int serial_set_params(int fd, int baudrate, int bits, int parity,
 130                               int stopbits, int flowcontrol);
 131 SR_PRIV int serial_set_paramstr(int fd, const char *paramstr);
 132
 133 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 134
 135 #ifdef HAVE_LIBUSB_1_0
 136 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 137 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 138                                    const char *filename);
 139 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 140                                   const char *filename);
 141 #endif
 142
 143 #endif