]> sigrok.org Git - libsigrok.git/blob - sigrok-internal.h
sr: Eliminate usb/serial instances from API.
[libsigrok.git] / sigrok-internal.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_INTERNAL_H
21 #define SIGROK_SIGROK_INTERNAL_H
22
23 #include <stdarg.h>
24 #include <glib.h>
25 #ifdef HAVE_LIBUSB_1_0
26 #include <libusb.h>
27 #endif
28
29 /*--- Macros ----------------------------------------------------------------*/
30
31 #ifndef ARRAY_SIZE
32 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
33 #endif
34
35 #ifndef ARRAY_AND_SIZE
36 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
37 #endif
38
39 /* Size of a datastore chunk in units */
40 #define DATASTORE_CHUNKSIZE (512 * 1024)
41
42 /*--- hwplugin.c ------------------------------------------------------------*/
43
44 int load_hwplugins(void);
45
46 #ifdef HAVE_LIBUSB_1_0
47 struct sr_usb_device_instance {
48         uint8_t bus;
49         uint8_t address;
50         struct libusb_device_handle *devhdl;
51 };
52 #endif
53
54 struct sr_serial_device_instance {
55         char *port;
56         int fd;
57 };
58
59 #ifdef HAVE_LIBUSB_1_0
60 /* USB-specific instances */
61 struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
62                 uint8_t address, struct libusb_device_handle *hdl);
63 void sr_usb_device_instance_free(struct sr_usb_device_instance *usb);
64 #endif
65
66 /* Serial-specific instances */
67 struct sr_serial_device_instance *sr_serial_device_instance_new(
68                                         const char *port, int fd);
69 void sr_serial_device_instance_free(struct sr_serial_device_instance *serial);
70
71 /*--- log.c -----------------------------------------------------------------*/
72
73 int sr_log(int loglevel, const char *format, ...);
74 int sr_spew(const char *format, ...);
75 int sr_dbg(const char *format, ...);
76 int sr_info(const char *format, ...);
77 int sr_warn(const char *format, ...);
78 int sr_err(const char *format, ...);
79
80 /*--- hardware/common/serial.c ----------------------------------------------*/
81
82 GSList *list_serial_ports(void);
83 int serial_open(const char *pathname, int flags);
84 int serial_close(int fd);
85 int serial_flush(int fd);
86 int serial_write(int fd, const void *buf, size_t count);
87 int serial_read(int fd, void *buf, size_t count);
88 void *serial_backup_params(int fd);
89 void serial_restore_params(int fd, void *backup);
90 int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
91                       int flowcontrol);
92
93 /*--- hardware/common/ezusb.c -----------------------------------------------*/
94
95 #ifdef HAVE_LIBUSB_1_0
96 int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
97 int ezusb_install_firmware(libusb_device_handle *hdl, const char *filename);
98 int ezusb_upload_firmware(libusb_device *dev, int configuration,
99                           const char *filename);
100 #endif
101
102 /*--- hardware/common/misc.c ------------------------------------------------*/
103
104 #ifdef HAVE_LIBUSB_1_0
105 int opendev2(int device_index, struct sr_device_instance **sdi,
106              libusb_device *dev, struct libusb_device_descriptor *des,
107              int *skip, uint16_t vid, uint16_t pid, int interface);
108 int opendev3(struct sr_device_instance **sdi, libusb_device *dev,
109              struct libusb_device_descriptor *des,
110              uint16_t vid, uint16_t pid, int interface);
111 #endif
112
113 #endif