]> sigrok.org Git - libsigrok.git/blob - src/hardware/scpi-pps/protocol.c
scpi-pps: Optimize channel selection.
[libsigrok.git] / src / hardware / scpi-pps / protocol.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2014 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 #include <string.h>
21 #include <stdarg.h>
22 #include "protocol.h"
23
24 SR_PRIV char *scpi_cmd_get(const struct sr_dev_inst *sdi, int command)
25 {
26         struct dev_context *devc;
27         unsigned int i;
28         char *cmd;
29
30         devc = sdi->priv;
31         cmd = NULL;
32         for (i = 0; i < devc->device->num_commands; i++) {
33                 if (devc->device->commands[i].command == command) {
34                         cmd = devc->device->commands[i].string;
35                         break;
36                 }
37         }
38
39         return cmd;
40 }
41
42 SR_PRIV int scpi_cmd(const struct sr_dev_inst *sdi, int command, ...)
43 {
44         struct sr_scpi_dev_inst *scpi;
45         va_list args;
46         int ret;
47         char *cmd;
48
49         if (!(cmd = scpi_cmd_get(sdi, command))) {
50                 /* Device does not implement this command, that's OK. */
51                 return SR_OK_CONTINUE;
52         }
53
54         scpi = sdi->conn;
55         va_start(args, command);
56         ret = sr_scpi_send_variadic(scpi, cmd, args);
57         va_end(args);
58
59         return ret;
60 }
61
62 SR_PRIV int scpi_cmd_resp(const struct sr_dev_inst *sdi, GVariant **gvar,
63                 const GVariantType *gvtype, int command, ...)
64 {
65         struct sr_scpi_dev_inst *scpi;
66         va_list args;
67         double d;
68         int ret;
69         char *cmd, *s;
70
71         if (!(cmd = scpi_cmd_get(sdi, command))) {
72                 /* Device does not implement this command, that's OK. */
73                 return SR_OK_CONTINUE;
74         }
75
76         scpi = sdi->conn;
77         va_start(args, command);
78         ret = sr_scpi_send_variadic(scpi, cmd, args);
79         va_end(args);
80         if (ret != SR_OK)
81                 return ret;
82
83         if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_BOOLEAN)) {
84                 if ((ret = sr_scpi_get_string(scpi, NULL, &s)) != SR_OK)
85                         return ret;
86                 if (!strcasecmp(s, "ON") || !strcasecmp(s, "1") || !strcasecmp(s, "YES"))
87                         *gvar = g_variant_new_boolean(TRUE);
88                 else if (!strcasecmp(s, "OFF") || !strcasecmp(s, "0") || !strcasecmp(s, "NO"))
89                         *gvar = g_variant_new_boolean(FALSE);
90                 else
91                         ret = SR_ERR;
92         } if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_DOUBLE)) {
93                 if ((ret = sr_scpi_get_double(scpi, NULL, &d)) == SR_OK)
94                         *gvar = g_variant_new_double(d);
95         } if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_STRING)) {
96                 if ((ret = sr_scpi_get_string(scpi, NULL, &s)) == SR_OK)
97                         *gvar = g_variant_new_string(s);
98         }
99
100         return ret;
101 }
102
103 SR_PRIV int select_channel(const struct sr_dev_inst *sdi, struct sr_channel *ch)
104 {
105         struct dev_context *devc;
106         struct pps_channel *cur_pch, *new_pch;
107         int ret;
108
109         if (g_slist_length(sdi->channels) == 1)
110                 return SR_OK;
111
112         devc = sdi->priv;
113         if (ch == devc->cur_channel)
114                 return SR_OK;
115
116         new_pch = ch->priv;
117         if (devc->cur_channel) {
118                 cur_pch = devc->cur_channel->priv;
119                 if (cur_pch->hw_output_idx == new_pch->hw_output_idx) {
120                         /* Same underlying output channel. */
121                         devc->cur_channel = ch;
122                         return SR_OK;
123                 }
124         }
125
126         if ((ret = scpi_cmd(sdi, SCPI_CMD_SELECT_CHANNEL, new_pch->hwname)) == SR_OK)
127                 devc->cur_channel = ch;
128
129         return ret;
130 }
131
132 SR_PRIV struct sr_channel *next_enabled_channel(const struct sr_dev_inst *sdi,
133                 struct sr_channel *cur_channel)
134 {
135         struct sr_channel *next_channel;
136         GSList *l;
137
138         next_channel = cur_channel;
139         do {
140                 l = g_slist_find(sdi->channels, next_channel);
141                 if (l && l->next)
142                         next_channel = l->next->data;
143                 else
144                         next_channel = sdi->channels->data;
145         } while (!next_channel->enabled);
146
147         return next_channel;
148 }
149
150 SR_PRIV int scpi_pps_receive_data(int fd, int revents, void *cb_data)
151 {
152         struct dev_context *devc;
153         struct sr_datafeed_packet packet;
154         struct sr_datafeed_analog analog;
155         const struct sr_dev_inst *sdi;
156         struct sr_channel *next_channel;
157         struct sr_scpi_dev_inst *scpi;
158         struct pps_channel *pch;
159         float f;
160         int cmd;
161
162         (void)fd;
163         (void)revents;
164
165         if (!(sdi = cb_data))
166                 return TRUE;
167
168         if (!(devc = sdi->priv))
169                 return TRUE;
170
171         scpi = sdi->conn;
172
173         /* Retrieve requested value for this state. */
174         if (sr_scpi_get_float(scpi, NULL, &f) == SR_OK) {
175                 pch = devc->cur_channel->priv;
176                 packet.type = SR_DF_ANALOG;
177                 packet.payload = &analog;
178                 analog.channels = g_slist_append(NULL, devc->cur_channel);
179                 analog.num_samples = 1;
180                 analog.mq = pch->mq;
181                 if (pch->mq == SR_MQ_VOLTAGE)
182                         analog.unit = SR_UNIT_VOLT;
183                 else if (pch->mq == SR_MQ_CURRENT)
184                         analog.unit = SR_UNIT_AMPERE;
185                 else if (pch->mq == SR_MQ_POWER)
186                         analog.unit = SR_UNIT_WATT;
187                 analog.mqflags = SR_MQFLAG_DC;
188                 analog.data = &f;
189                 sr_session_send(sdi, &packet);
190                 g_slist_free(analog.channels);
191         }
192
193         if (g_slist_length(sdi->channels) > 1) {
194                 next_channel = next_enabled_channel(sdi, devc->cur_channel);
195                 if (select_channel(sdi, next_channel) != SR_OK) {
196                         sr_err("Failed to select channel %s", next_channel->name);
197                         return FALSE;
198                 }
199         }
200
201         pch = devc->cur_channel->priv;
202         if (pch->mq == SR_MQ_VOLTAGE)
203                 cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
204         else if (pch->mq == SR_MQ_CURRENT)
205                 cmd = SCPI_CMD_GET_MEAS_CURRENT;
206         else if (pch->mq == SR_MQ_POWER)
207                 cmd = SCPI_CMD_GET_MEAS_POWER;
208         else
209                 return SR_ERR;
210         scpi_cmd(sdi, cmd);
211
212         return TRUE;
213 }