]> sigrok.org Git - libsigrok.git/blame - src/hardware/mic-985xx/api.c
Minor cosmetics, cleanups.
[libsigrok.git] / src / hardware / mic-985xx / api.c
CommitLineData
7ec5b549
UH
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
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 2 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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#include "protocol.h"
22
a0e0bb41 23static const uint32_t scanopts[] = {
0cd8e231
UH
24 SR_CONF_CONN,
25 SR_CONF_SERIALCOMM,
0cd8e231
UH
26};
27
e07edc83
UH
28static const uint32_t drvopts_temp[] = {
29 SR_CONF_THERMOMETER,
30};
31
32static const uint32_t drvopts_temp_hum[] = {
0cd8e231
UH
33 SR_CONF_THERMOMETER,
34 SR_CONF_HYGROMETER,
d6e1e6c4
UH
35};
36
37static const uint32_t devopts[] = {
38 SR_CONF_CONTINUOUS | SR_CONF_SET,
5827f61b
BV
39 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
40 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
0cd8e231 41};
7ec5b549 42
6f3e5335 43SR_PRIV struct sr_dev_driver mic_98581_driver_info;
0cd8e231
UH
44SR_PRIV struct sr_dev_driver mic_98583_driver_info;
45
46SR_PRIV const struct mic_dev_info mic_devs[] = {
47 {
6f3e5335
UH
48 "MIC", "98581", "38400/8n2", 32000, TRUE, FALSE, 6,
49 packet_valid_temp,
50 &mic_98581_driver_info, receive_data_MIC_98581,
51 },
52 {
53 "MIC", "98583", "38400/8n2", 32000, TRUE, TRUE, 10,
54 packet_valid_temp_hum,
0cd8e231
UH
55 &mic_98583_driver_info, receive_data_MIC_98583,
56 },
57};
58
3b412e3a 59static int dev_clear(int idx)
7ec5b549 60{
25e7adad 61 return std_dev_clear(mic_devs[idx].di, NULL);
7ec5b549
UH
62}
63
6078d2c9 64static int init(struct sr_context *sr_ctx, int idx)
7ec5b549 65{
f6beaac5 66 return std_init(sr_ctx, mic_devs[idx].di, LOG_PREFIX);
7ec5b549
UH
67}
68
6078d2c9 69static GSList *mic_scan(const char *conn, const char *serialcomm, int idx)
7ec5b549 70{
0cd8e231 71 struct sr_dev_inst *sdi;
7ec5b549 72 struct drv_context *drvc;
0cd8e231 73 struct dev_context *devc;
0cd8e231 74 struct sr_serial_dev_inst *serial;
7ec5b549
UH
75 GSList *devices;
76
91219afc 77 serial = sr_serial_dev_inst_new(conn, serialcomm);
7ec5b549 78
51056d61 79 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
0cd8e231
UH
80 return NULL;
81
82 drvc = mic_devs[idx].di->priv;
7ec5b549 83 devices = NULL;
0cd8e231 84 serial_flush(serial);
7ec5b549 85
0cd8e231
UH
86 /* TODO: Query device type. */
87 // ret = mic_cmd_get_device_info(serial);
88
89 sr_info("Found device on port %s.", conn);
90
91 /* TODO: Fill in version from protocol response. */
aac29cc1 92 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
93 sdi->status = SR_ST_INACTIVE;
94 sdi->vendor = g_strdup(mic_devs[idx].vendor);
95 sdi->model = g_strdup(mic_devs[idx].device);
f57d8ffe 96 devc = g_malloc0(sizeof(struct dev_context));
886bd5e0
UH
97 sdi->inst_type = SR_INST_SERIAL;
98 sdi->conn = serial;
0cd8e231
UH
99 sdi->priv = devc;
100 sdi->driver = mic_devs[idx].di;
101
5e23fcab 102 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Temperature");
0cd8e231 103
5e23fcab
ML
104 if (mic_devs[idx].has_humidity)
105 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "Humidity");
0cd8e231
UH
106
107 drvc->instances = g_slist_append(drvc->instances, sdi);
108 devices = g_slist_append(devices, sdi);
109
0cd8e231 110 serial_close(serial);
7ec5b549
UH
111
112 return devices;
113}
114
6078d2c9 115static GSList *scan(GSList *options, int idx)
0cd8e231
UH
116{
117 struct sr_config *src;
118 GSList *l, *devices;
119 const char *conn, *serialcomm;
120
121 conn = serialcomm = NULL;
122 for (l = options; l; l = l->next) {
123 src = l->data;
124 switch (src->key) {
125 case SR_CONF_CONN:
2c2be401 126 conn = g_variant_get_string(src->data, NULL);
0cd8e231
UH
127 break;
128 case SR_CONF_SERIALCOMM:
06c45a66 129 serialcomm = g_variant_get_string(src->data, NULL);
0cd8e231
UH
130 break;
131 }
132 }
133 if (!conn)
134 return NULL;
135
136 if (serialcomm) {
137 /* Use the provided comm specs. */
6078d2c9 138 devices = mic_scan(conn, serialcomm, idx);
0cd8e231
UH
139 } else {
140 /* Try the default. */
6078d2c9 141 devices = mic_scan(conn, mic_devs[idx].conn, idx);
0cd8e231
UH
142 }
143
144 return devices;
145}
146
6078d2c9 147static GSList *dev_list(int idx)
7ec5b549 148{
0e94d524 149 return ((struct drv_context *)(mic_devs[idx].di->priv))->instances;
7ec5b549
UH
150}
151
6078d2c9 152static int cleanup(int idx)
7ec5b549 153{
3b412e3a 154 return dev_clear(idx);
7ec5b549
UH
155}
156
584560f1 157static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 158 const struct sr_channel_group *cg)
7ec5b549 159{
0cd8e231 160 struct dev_context *devc;
7ec5b549 161
53b4680f 162 (void)cg;
8f996b89 163
0cd8e231 164 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 165 return SR_ERR_DEV_CLOSED;
7ec5b549 166
0cd8e231
UH
167 devc = sdi->priv;
168
584560f1 169 switch (key) {
0cd8e231 170 case SR_CONF_LIMIT_SAMPLES:
2c2be401 171 devc->limit_samples = g_variant_get_uint64(data);
0cd8e231
UH
172 sr_dbg("Setting sample limit to %" PRIu64 ".",
173 devc->limit_samples);
174 break;
175 case SR_CONF_LIMIT_MSEC:
2c2be401 176 devc->limit_msec = g_variant_get_uint64(data);
0cd8e231
UH
177 sr_dbg("Setting time limit to %" PRIu64 "ms.",
178 devc->limit_msec);
179 break;
7ec5b549 180 default:
bd6fbf62 181 return SR_ERR_NA;
7ec5b549
UH
182 }
183
0cd8e231 184 return SR_OK;
7ec5b549
UH
185}
186
584560f1 187static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
e07edc83 188 const struct sr_channel_group *cg, int idx)
7ec5b549 189{
53b4680f 190 (void)cg;
7ec5b549
UH
191
192 switch (key) {
0cd8e231 193 case SR_CONF_SCAN_OPTIONS:
584560f1 194 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 195 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0cd8e231
UH
196 break;
197 case SR_CONF_DEVICE_OPTIONS:
e07edc83
UH
198 if (!sdi && !mic_devs[idx].has_humidity) {
199 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
200 drvopts_temp, ARRAY_SIZE(drvopts_temp),
201 sizeof(uint32_t));
202 } else if (!sdi && mic_devs[idx].has_humidity) {
d6e1e6c4 203 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
e07edc83
UH
204 drvopts_temp_hum, ARRAY_SIZE(drvopts_temp_hum),
205 sizeof(uint32_t));
206 } else {
d6e1e6c4 207 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 208 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
e07edc83 209 }
0cd8e231 210 break;
7ec5b549 211 default:
bd6fbf62 212 return SR_ERR_NA;
7ec5b549
UH
213 }
214
215 return SR_OK;
216}
217
6078d2c9 218static int dev_acquisition_start(const struct sr_dev_inst *sdi,
0cd8e231 219 void *cb_data, int idx)
7ec5b549 220{
0cd8e231 221 struct dev_context *devc;
886bd5e0 222 struct sr_serial_dev_inst *serial;
0cd8e231 223
e73ffd42
BV
224 if (sdi->status != SR_ST_ACTIVE)
225 return SR_ERR_DEV_CLOSED;
0cd8e231 226
e73ffd42 227 devc = sdi->priv;
0cd8e231 228 devc->cb_data = cb_data;
0cd8e231
UH
229 devc->num_samples = 0;
230 devc->starttime = g_get_monotonic_time();
231
232 /* Send header packet to the session bus. */
29a27196 233 std_session_send_df_header(cb_data, LOG_PREFIX);
0cd8e231
UH
234
235 /* Poll every 100ms, or whenever some data comes in. */
886bd5e0 236 serial = sdi->conn;
102f1239 237 serial_source_add(sdi->session, serial, G_IO_IN, 100,
0cd8e231 238 mic_devs[idx].receive_data, (void *)sdi);
7ec5b549
UH
239
240 return SR_OK;
241}
242
6078d2c9 243static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
7ec5b549 244{
d43b0908
BV
245 return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
246 sdi->conn, LOG_PREFIX);
7ec5b549
UH
247}
248
0cd8e231
UH
249/* Driver-specific API function wrappers */
250#define HW_INIT(X) \
4f840ce9 251static int init_##X(struct sr_dev_driver *di, struct sr_context *sr_ctx) { \
1a863916 252 (void)di; return init(sr_ctx, X); }
0cd8e231 253#define HW_CLEANUP(X) \
4f840ce9 254static int cleanup_##X(const struct sr_dev_driver *di) { \
1a863916 255 (void)di; return cleanup(X); }
0cd8e231 256#define HW_SCAN(X) \
4f840ce9 257static GSList *scan_##X(struct sr_dev_driver *di, GSList *options) { \
1a863916 258 (void)di; return scan(options, X); }
0cd8e231 259#define HW_DEV_LIST(X) \
4f840ce9 260static GSList *dev_list_##X(const struct sr_dev_driver *di) { \
1a863916 261 (void)di; return dev_list(X); }
3b412e3a 262#define HW_DEV_CLEAR(X) \
4f840ce9 263static int dev_clear_##X(const struct sr_dev_driver *di) { \
1a863916 264 (void)di; return dev_clear(X); }
e07edc83
UH
265#define HW_CONFIG_LIST(X) \
266static int config_list_##X(uint32_t key, GVariant **data, \
267const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { \
268return config_list(key, data, sdi, cg, X); }
0cd8e231 269#define HW_DEV_ACQUISITION_START(X) \
6078d2c9
UH
270static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
271void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
0cd8e231
UH
272
273/* Driver structs and API function wrappers */
274#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
275HW_INIT(ID_UPPER) \
276HW_CLEANUP(ID_UPPER) \
277HW_SCAN(ID_UPPER) \
278HW_DEV_LIST(ID_UPPER) \
3b412e3a 279HW_DEV_CLEAR(ID_UPPER) \
e07edc83 280HW_CONFIG_LIST(ID_UPPER) \
0cd8e231
UH
281HW_DEV_ACQUISITION_START(ID_UPPER) \
282SR_PRIV struct sr_dev_driver ID##_driver_info = { \
283 .name = NAME, \
284 .longname = LONGNAME, \
285 .api_version = 1, \
6078d2c9
UH
286 .init = init_##ID_UPPER, \
287 .cleanup = cleanup_##ID_UPPER, \
288 .scan = scan_##ID_UPPER, \
289 .dev_list = dev_list_##ID_UPPER, \
3b412e3a 290 .dev_clear = dev_clear_##ID_UPPER, \
0cd8e231
UH
291 .config_get = NULL, \
292 .config_set = config_set, \
e07edc83 293 .config_list = config_list_##ID_UPPER, \
854434de 294 .dev_open = std_serial_dev_open, \
bf2c987f 295 .dev_close = std_serial_dev_close, \
6078d2c9
UH
296 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
297 .dev_acquisition_stop = dev_acquisition_stop, \
0cd8e231 298 .priv = NULL, \
7ec5b549 299};
0cd8e231 300
6f3e5335 301DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
0cd8e231 302DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")