2 * This file is part of the libsigrok project.
4 * Copyright (C) 2016 Lars-Peter Clausen <lars@metafoo.de>
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.
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.
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/>.
22 * Software limits helper functions
31 #include <libsigrok/libsigrok.h>
32 #include "libsigrok-internal.h"
34 #define LOG_PREFIX "sw_limits"
37 * Initialize a software limit instance
39 * Must be called before any other operations are performed on a struct
40 * sr_sw_limits and should typically be called after the data structure has been
43 * @param limits the software limit instance to initialize
45 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits)
47 limits->limit_samples = 0;
48 limits->limit_frames = 0;
49 limits->limit_msec = 0;
53 * Get software limit configuration
55 * Retrieve the currently configured software limit for the specified key.
56 * Should be called from the drivers config_get() callback.
58 * @param limits software limit instance
59 * @param key config item key
60 * @param data config item data
61 * @return SR_ERR_NA if @p key is not a supported limit, SR_OK otherwise
63 SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
67 case SR_CONF_LIMIT_SAMPLES:
68 *data = g_variant_new_uint64(limits->limit_samples);
70 case SR_CONF_LIMIT_FRAMES:
71 *data = g_variant_new_uint64(limits->limit_frames);
73 case SR_CONF_LIMIT_MSEC:
74 *data = g_variant_new_uint64(limits->limit_msec / 1000);
84 * Set software limit configuration
86 * Configure software limit for the specified key. Should be called from the
87 * drivers config_set() callback.
89 * @param limits software limit instance
90 * @param key config item key
91 * @param data config item data
92 * @return SR_ERR_NA if @p key is not a supported limit, SR_OK otherwise
94 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
98 case SR_CONF_LIMIT_SAMPLES:
99 limits->limit_samples = g_variant_get_uint64(data);
101 case SR_CONF_LIMIT_FRAMES:
102 limits->limit_frames = g_variant_get_uint64(data);
104 case SR_CONF_LIMIT_MSEC:
105 limits->limit_msec = g_variant_get_uint64(data) * 1000;
115 * Start a new data acquisition session
117 * Resets the internal accounting for all software limits. Usually should be
118 * called from the drivers acquisition_start() callback.
120 * @param limits software limits instance
122 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits)
124 limits->samples_read = 0;
125 limits->frames_read = 0;
126 limits->start_time = g_get_monotonic_time();
130 * Check if any of the configured software limits has been reached
132 * Usually should be called at the end of the drivers work function after all
133 * processing has been done.
135 * @param limits software limits instance
136 * @returns TRUE if any of the software limits has been reached and the driver
137 * should stop data acquisition, otherwise FALSE.
139 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits)
141 if (limits->limit_samples) {
142 if (limits->samples_read >= limits->limit_samples) {
143 sr_dbg("Requested number of samples (%" PRIu64
144 ") reached.", limits->limit_samples);
149 if (limits->limit_frames) {
150 if (limits->frames_read >= limits->limit_frames) {
151 sr_dbg("Requested number of frames (%" PRIu64
152 ") reached.", limits->limit_frames);
157 if (limits->limit_msec) {
159 now = g_get_monotonic_time();
160 if (now > limits->start_time &&
161 now - limits->start_time > limits->limit_msec) {
162 sr_dbg("Requested sampling time (%" PRIu64
163 "ms) reached.", limits->limit_msec / 1000);
172 * Update the amount of samples that have been read
174 * Update the amount of samples that have been read in the current data
175 * acquisition run. For each invocation @p samples_read will be accumulated and
176 * once the configured sample limit has been reached sr_sw_limits_check() will
179 * @param limits software limits instance
180 * @param samples_read the amount of samples that have been read
182 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
183 uint64_t samples_read)
185 limits->samples_read += samples_read;
189 * Update the amount of frames that have been read
191 * Update the amount of frames that have been read in the current data
192 * acquisition run. For each invocation @p frames_read will be accumulated and
193 * once the configured frame limit has been reached sr_sw_limits_check() will
196 * @param limits software limits instance
197 * @param frames_read the amount of frames that have been read
199 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
200 uint64_t frames_read)
202 limits->frames_read += frames_read;