Doxygen: Properly mark a few symbols as private.

[libsigrok.git] / src / libsigrok-internal.h

diff --git a/src/libsigrok-internal.h b/src/libsigrok-internal.h
index c79524cf1c056f6cb075e18d8a42ce57940c9964..140d11e154b06beba927a4c077a96ff6095c5905 100644 (file)
--- a/src/libsigrok-internal.h
+++ b/src/libsigrok-internal.h
@@ -17,12 +17,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
- * @file
- *
- * @internal
- */
-
 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
 
@@ -279,7 +273,7 @@ struct zip_stat;
 #ifdef __APPLE__
 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
 #else
-#define SR_DRIVER_LIST_SECTION "sr_driver_list"
+#define SR_DRIVER_LIST_SECTION "__sr_driver_list"
 #endif
 
 /**
@@ -756,7 +750,9 @@ struct sr_serial_dev_inst {
 #ifdef HAVE_LIBHIDAPI
        enum ser_hid_chip_t {
                SER_HID_CHIP_UNKNOWN,           /**!< place holder */
+               SER_HID_CHIP_BTC_BU86X,         /**!< Brymen BU86x */
                SER_HID_CHIP_SIL_CP2110,        /**!< SiLabs CP2110 */
+               SER_HID_CHIP_VICTOR_DMM,        /**!< Victor 70/86 DMM cable */
                SER_HID_CHIP_WCH_CH9325,        /**!< WCH CH9325 */
                SER_HID_CHIP_LAST,              /**!< sentinel */
        } hid_chip;
@@ -1085,6 +1081,10 @@ SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigne
 
 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
 
+SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
+       int baudrate, int bits, int parity, int stopbits,
+       int flowcontrol, int rts, int dtr);
+
 /*--- resource.c ------------------------------------------------------------*/
 
 SR_PRIV int64_t sr_file_get_size(FILE *file);
@@ -1230,7 +1230,6 @@ extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
 struct vid_pid_item {
        uint16_t vid, pid;
 };
-#define VID_PID_TERM   ALL_ZERO
 
 struct ser_hid_chip_functions {
        const char *chipname;
@@ -1247,8 +1246,10 @@ struct ser_hid_chip_functions {
        int (*flush)(struct sr_serial_dev_inst *serial);
        int (*drain)(struct sr_serial_dev_inst *serial);
 };
+extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
+extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
 #endif
 #endif
@@ -1566,6 +1567,20 @@ SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
                             struct sr_datafeed_analog *analog, void *info);
 
+/*--- dmm/bm86x.c -----------------------------------------------------------*/
+
+#define BRYMEN_BM86X_PACKET_SIZE 24
+#define BRYMEN_BM86X_DISPLAY_COUNT 2
+
+struct brymen_bm86x_info { size_t ch_idx; };
+
+#ifdef HAVE_SERIAL_COMM
+SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
+#endif
+SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
+SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
+               struct sr_datafeed_analog *analog, void *info);
+
 /*--- dmm/ut71x.c -----------------------------------------------------------*/
 
 #define UT71X_PACKET_SIZE 11
@@ -1619,21 +1634,53 @@ SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
 
 /*--- lcr/es51919.c ---------------------------------------------------------*/
 
-SR_PRIV void es51919_serial_clean(void *priv);
-SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
-                                               const char *vendor,
-                                               const char *model);
-SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
-                                     const struct sr_dev_inst *sdi,
-                                     const struct sr_channel_group *cg);
-SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
-                                     const struct sr_dev_inst *sdi,
-                                     const struct sr_channel_group *cg);
-SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
-                                      const struct sr_dev_inst *sdi,
-                                      const struct sr_channel_group *cg);
-SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi);
-SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi);
+/* Acquisition details which apply to all supported serial-lcr devices. */
+struct lcr_parse_info {
+       size_t ch_idx;
+       uint64_t output_freq;
+       const char *circuit_model;
+};
+
+#define ES51919_PACKET_SIZE    17
+#define ES51919_CHANNEL_COUNT  2
+#define ES51919_COMM_PARAM     "9600/8n1/rts=1/dtr=1"
+
+SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
+SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
+SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
+SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
+SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
+       struct sr_datafeed_analog *analog, void *info);
+
+/*--- lcr/vc4080.c ----------------------------------------------------------*/
+
+/* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
+
+#define VC4080_PACKET_SIZE     39
+#define VC4080_COMM_PARAM      "1200/8n1"
+#define VC4080_WITH_DQ_CHANS   0 /* Enable separate D/Q channels? */
+
+enum vc4080_display {
+       VC4080_DISPLAY_PRIMARY,
+       VC4080_DISPLAY_SECONDARY,
+#if VC4080_WITH_DQ_CHANS
+       VC4080_DISPLAY_D_VALUE,
+       VC4080_DISPLAY_Q_VALUE,
+#endif
+       VC4080_CHANNEL_COUNT,
+};
+
+extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
+
+SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
+SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
+SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
+SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
+       struct sr_datafeed_analog *analog, void *info);
 
 /*--- dmm/ut372.c -----------------------------------------------------------*/
 
@@ -1710,10 +1757,8 @@ struct eev121gw_info {
 
 extern SR_PRIV const char *eev121gw_channel_formats[];
 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
-SR_PRIV int sr_eev121gw_parse(const uint8_t *buf, float *floatval,
-                            struct sr_datafeed_analog *analog, void *info);
 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
-                            struct sr_datafeed_analog *analog, void *info);
+               struct sr_datafeed_analog *analog, void *info);
 
 /*--- scale/kern.c ----------------------------------------------------------*/