dcttech-usbrelay: implement multiplexer driver for USB relay card
[libsigrok.git] / src / hardware / dcttech-usbrelay / protocol.h
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2021 Gerhard Sittig <gerhard.sittig@gmx.net>
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_HARDWARE_DCTTECH_USBRELAY_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_DCTTECH_USBRELAY_PROTOCOL_H
22
23 #include <glib.h>
24 #include <hidapi.h>
25 #include <libsigrok/libsigrok.h>
26 #include <stdint.h>
27
28 #include "libsigrok-internal.h"
29
30 #define LOG_PREFIX "dcttech-usbrelay"
31
32 /* USB identification. */
33 #define VENDOR_ID 0x16c0
34 #define PRODUCT_ID 0x05df
35 #define VENDOR_STRING "www.dcttech.com"
36 #define PRODUCT_STRING_PREFIX "USBRelay"
37
38 /* HID report layout. */
39 #define REPORT_NUMBER 0
40 #define REPORT_BYTECOUNT 8
41 #define SERNO_LENGTH 5
42 #define STATE_INDEX 7
43
44 struct dev_context {
45         char *hid_path;
46         hid_device *hid_dev;
47         size_t relay_count;
48         uint32_t relay_mask;
49         uint32_t relay_state;
50 };
51
52 struct channel_group_context {
53         size_t number;
54 };
55
56 SR_PRIV int dcttech_usbrelay_update_state(const struct sr_dev_inst *sdi);
57 SR_PRIV int dcttech_usbrelay_switch_cg(const struct sr_dev_inst *sdi,
58         const struct sr_channel_group *cg, gboolean on);
59 SR_PRIV int dcttech_usbrelay_query_cg(const struct sr_dev_inst *sdi,
60         const struct sr_channel_group *cg, gboolean *on);
61
62 #endif