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