GPIOD_CXX_API ::std::map<line::offset, line_settings> line_config::get_line_settings() const
{
+ ::std::size_t num_offsets = ::gpiod_line_config_get_num_configured_offsets(
+ this->_m_priv->config.get());
::std::map<line::offset, line_settings> settings_map;
- ::std::size_t num_offsets;
- unsigned int *offsets_ptr;
- int ret;
-
- ret = ::gpiod_line_config_get_offsets(this->_m_priv->config.get(),
- &num_offsets, &offsets_ptr);
- if (ret)
- throw_from_errno("unable to retrieve line offsets");
+ ::std::vector<unsigned int> offsets(num_offsets);
if (num_offsets == 0)
return settings_map;
- ::std::unique_ptr<unsigned int, malloc_deleter> offsets(offsets_ptr);
+ ::gpiod_line_config_get_configured_offsets(this->_m_priv->config.get(),
+ offsets.data(), num_offsets);
for (size_t i = 0; i < num_offsets; i++) {
line_settings settings;
settings._m_priv->settings.reset(::gpiod_line_config_get_line_settings(
this->_m_priv->config.get(),
- offsets.get()[i]));
+ offsets[i]));
if (!settings._m_priv->settings)
throw_from_errno("unable to retrieve line settings");
- settings_map[offsets.get()[i]] = ::std::move(settings);
+ settings_map[offsets[i]] = ::std::move(settings);
}
return settings_map;
void line_request::impl::set_request_ptr(line_request_ptr& ptr)
{
this->request = ::std::move(ptr);
- this->offset_buf.resize(::gpiod_line_request_get_num_lines(this->request.get()));
+ this->offset_buf.resize(::gpiod_line_request_get_num_requested_lines(this->request.get()));
}
void line_request::impl::fill_offset_buf(const line::offsets& offsets)
{
this->_m_priv->throw_if_released();
- return ::gpiod_line_request_get_num_lines(this->_m_priv->request.get());
+ return ::gpiod_line_request_get_num_requested_lines(this->_m_priv->request.get());
}
GPIOD_CXX_API line::offsets line_request::offsets() const
::std::vector<unsigned int> buf(num_lines);
line::offsets offsets(num_lines);
- ::gpiod_line_request_get_offsets(this->_m_priv->request.get(), buf.data());
+ ::gpiod_line_request_get_requested_offsets(this->_m_priv->request.get(), buf.data(), buf.size());
for (unsigned int i = 0; i < num_lines; i++)
offsets[i] = buf[i];
request_num_lines(request_object *self, void *Py_UNUSED(ignored))
{
return PyLong_FromUnsignedLong(
- gpiod_line_request_get_num_lines(self->request));
+ gpiod_line_request_get_num_requested_lines(self->request));
}
static PyObject *request_offsets(request_object *self, void *Py_UNUSED(ignored))
size_t num_lines, i;
int ret;
- num_lines = gpiod_line_request_get_num_lines(self->request);
+ num_lines = gpiod_line_request_get_num_requested_lines(self->request);
offsets = PyMem_Calloc(num_lines, sizeof(unsigned int));
if (!offsets)
return PyErr_NoMemory();
- gpiod_line_request_get_offsets(self->request, offsets);
+ gpiod_line_request_get_requested_offsets(self->request, offsets, num_lines);
lines = PyList_New(num_lines);
if (!lines) {
unsigned int *offsets;
size_t num_lines;
- num_lines = gpiod_line_request_get_num_lines(request);
+ num_lines = gpiod_line_request_get_num_requested_lines(request);
req_obj = PyObject_New(request_object, &request_type);
if (!req_obj)
/// Maps offset to Value.
pub type ValueMap = IntMap<Value>;
+ /// Maps offsets to Settings
+ pub type SettingsMap = IntMap<Settings>;
+
impl Value {
pub fn new(val: gpiod::gpiod_line_value) -> Result<Self> {
Ok(match val {
// SPDX-FileCopyrightText: 2022 Linaro Ltd.
// SPDX-FileCopyrightTest: 2022 Viresh Kumar <viresh.kumar@linaro.org>
-use std::os::raw::{c_ulong, c_void};
-use std::slice;
+use std::os::raw::c_ulong;
use super::{
gpiod,
- line::{Offset, Settings},
+ line::{Offset, Settings, SettingsMap},
Error, OperationType, Result,
};
}
}
- /// Get line settings for offset.
- pub fn line_settings(&self, offset: Offset) -> Result<Settings> {
- // SAFETY: `gpiod_line_config` is guaranteed to be valid here.
- let settings = unsafe { gpiod::gpiod_line_config_get_line_settings(self.config, offset) };
-
- if settings.is_null() {
- return Err(Error::OperationFailed(
- OperationType::LineConfigGetSettings,
- errno::errno(),
- ));
- }
-
- Ok(Settings::new_with_settings(settings))
- }
+ /// Get a mapping of offsets to line settings stored by this object.
+ pub fn line_settings(&self) -> Result<SettingsMap> {
+ let mut map = SettingsMap::new();
+ // SAFETY: gpiod_line_config is guaranteed to be valid here
+ let num_lines = unsafe { gpiod::gpiod_line_config_get_num_configured_offsets(self.config) };
+ let mut offsets = vec![0; num_lines as usize];
- /// Get configured offsets.
- pub fn offsets(&self) -> Result<Vec<Offset>> {
- let mut num: u64 = 0;
- let mut ptr: *mut Offset = std::ptr::null_mut();
-
- // SAFETY: The `ptr` array returned by libgpiod is guaranteed to live as long
- // as it is not explicitly freed with `free()`.
- let ret = unsafe {
- gpiod::gpiod_line_config_get_offsets(
+ // SAFETY: gpiod_line_config is guaranteed to be valid here.
+ let num_stored = unsafe {
+ gpiod::gpiod_line_config_get_configured_offsets(
self.config,
- &mut num as *mut _ as *mut _,
- &mut ptr,
+ offsets.as_mut_ptr(),
+ num_lines,
)
};
- if ret == -1 {
- return Err(Error::OperationFailed(
- OperationType::LineConfigGetOffsets,
- errno::errno(),
- ));
+ for offset in &offsets[0..num_stored as usize] {
+ // SAFETY: `gpiod_line_config` is guaranteed to be valid here.
+ let settings =
+ unsafe { gpiod::gpiod_line_config_get_line_settings(self.config, *offset) };
+ if settings.is_null() {
+ return Err(Error::OperationFailed(
+ OperationType::LineConfigGetSettings,
+ errno::errno(),
+ ));
+ }
+
+ map.insert(*offset as u64, Settings::new_with_settings(settings));
}
- // SAFETY: The `ptr` array returned by libgpiod is guaranteed to live as long
- // as it is not explicitly freed with `free()`.
- let offsets = unsafe { slice::from_raw_parts(ptr as *const Offset, num as usize).to_vec() };
-
- // SAFETY: The `ptr` array is guaranteed to be valid here.
- unsafe { libc::free(ptr as *mut c_void) };
-
- Ok(offsets)
+ Ok(map)
}
}
/// Get the number of lines in the request.
pub fn num_lines(&self) -> usize {
// SAFETY: `gpiod_line_request` is guaranteed to be valid here.
- unsafe { gpiod::gpiod_line_request_get_num_lines(self.request) as usize }
+ unsafe { gpiod::gpiod_line_request_get_num_requested_lines(self.request) as usize }
}
/// Get the offsets of lines in the request.
let mut offsets = vec![0; self.num_lines() as usize];
// SAFETY: `gpiod_line_request` is guaranteed to be valid here.
- unsafe { gpiod::gpiod_line_request_get_offsets(self.request, offsets.as_mut_ptr()) };
+ let num_offsets = unsafe {
+ gpiod::gpiod_line_request_get_requested_offsets(
+ self.request,
+ offsets.as_mut_ptr(),
+ self.num_lines() as u64,
+ )
+ };
+ offsets.shrink_to(num_offsets as usize);
offsets
}
lconfig.add_line_settings(&[0, 1, 2], lsettings1).unwrap();
lconfig.add_line_settings(&[4, 5], lsettings2).unwrap();
+ let settings_map = lconfig.line_settings().unwrap();
+
// Retrieve settings
- let lsettings = lconfig.line_settings(1).unwrap();
+ let lsettings = settings_map.get(1).unwrap();
assert_eq!(
lsettings.prop(SettingKind::Direction).unwrap(),
SettingVal::Direction(Direction::Input)
SettingVal::Drive(Drive::PushPull)
);
- let lsettings = lconfig.line_settings(5).unwrap();
+ let lsettings = settings_map.get(5).unwrap();
assert_eq!(
lsettings.prop(SettingKind::Direction).unwrap(),
SettingVal::Direction(Direction::Output)
SettingVal::OutputValue(Value::Active)
);
}
-
- #[test]
- fn offsets() {
- let mut lsettings1 = line::Settings::new().unwrap();
- lsettings1.set_direction(Direction::Input).unwrap();
-
- let mut lsettings2 = line::Settings::new().unwrap();
- lsettings2.set_event_clock(EventClock::Realtime).unwrap();
-
- // Add settings for multiple lines
- let lconfig = line::Config::new().unwrap();
- lconfig.add_line_settings(&[0, 1, 2], lsettings1).unwrap();
- lconfig.add_line_settings(&[4, 5], lsettings2).unwrap();
-
- // Verify offsets
- let offsets = lconfig.offsets().unwrap();
- assert_eq!(offsets, [0, 1, 2, 4, 5]);
- }
}
AC_CHECK_HEADERS([poll.h], [], [HEADER_NOT_FOUND_LIB([poll.h])])
AC_CHECK_HEADERS([sys/sysmacros.h], [], [HEADER_NOT_FOUND_LIB([sys/sysmacros.h])])
AC_CHECK_HEADERS([sys/ioctl.h], [], [HEADER_NOT_FOUND_LIB([sys/ioctl.h])])
+AC_CHECK_HEADERS([sys/param.h], [], [HEADER_NOT_FOUND_LIB([sys/param.h])])
AC_CHECK_HEADERS([sys/stat.h], [], [HEADER_NOT_FOUND_LIB([sys/stat.h])])
AC_CHECK_HEADERS([sys/types.h], [], [HEADER_NOT_FOUND_LIB([sys/types.h])])
AC_CHECK_HEADERS([linux/const.h], [], [HEADER_NOT_FOUND_LIB([linux/const.h])])
gpiod_line_config_get_line_settings(struct gpiod_line_config *config,
unsigned int offset);
+/**
+ * @brief Get the number of configured line offsets.
+ * @param config Line config object.
+ * @return Number of offsets for which line settings have been added.
+ */
+size_t
+gpiod_line_config_get_num_configured_offsets(struct gpiod_line_config *config);
+
/**
* @brief Get configured offsets.
* @param config Line config object.
- * @param num_offsets Pointer to a variable in which the number of line offsets
- * will be stored.
- * @param offsets Pointer to a pointer which will be set to point to an array
- * containing the configured offsets. The array will be allocated
- * using malloc() and must be freed using free().
- * @return 0 on success, -1 on failure.
+ * @param offsets Array to store offsets.
+ * @param max_offsets Number of offsets that can be stored in the offsets array.
+ * @return Number of offsets stored in the offsets array.
+ *
+ * If max_offsets is lower than the number of lines actually requested (this
+ * value can be retrieved using ::gpiod_line_config_get_num_configured_offsets),
+ * then only up to max_lines offsets will be stored in offsets.
*/
-int gpiod_line_config_get_offsets(struct gpiod_line_config *config,
- size_t *num_offsets,
- unsigned int **offsets);
+size_t
+gpiod_line_config_get_configured_offsets(struct gpiod_line_config *config,
+ unsigned int *offsets,
+ size_t max_offsets);
/**
* @}
* @param request Line request object.
* @return Number of requested lines.
*/
-size_t gpiod_line_request_get_num_lines(struct gpiod_line_request *request);
+size_t
+gpiod_line_request_get_num_requested_lines(struct gpiod_line_request *request);
/**
* @brief Get the offsets of the lines in the request.
* @param request Line request object.
- * @param offsets Array to store offsets. Must be sized to hold the number of
- * lines returned by ::gpiod_line_request_get_num_lines.
+ * @param offsets Array to store offsets.
+ * @param max_offsets Number of offsets that can be stored in the offsets array.
+ * @return Number of offsets stored in the offsets array.
+ *
+ * If max_offsets is lower than the number of lines actually requested (this
+ * value can be retrieved using ::gpiod_line_request_get_num_requested_lines),
+ * then only up to max_lines offsets will be stored in offsets.
*/
-void gpiod_line_request_get_offsets(struct gpiod_line_request *request,
- unsigned int *offsets);
+size_t
+gpiod_line_request_get_requested_offsets(struct gpiod_line_request *request,
+ unsigned int *offsets,
+ size_t max_offsets);
/**
* @brief Get the value of a single requested line.
* @brief Get the values of all requested lines.
* @param request GPIO line request.
* @param values Array in which the values will be stored. Must be sized to
- * hold the number of lines returned by
- * ::gpiod_line_request_get_num_lines.
+ * hold the number of lines filled by
+ * ::gpiod_line_request_get_num_requested_lines.
* Each value is associated with the line identified by the
- * corresponding entry in the offset array returned by
- * ::gpiod_line_request_get_offsets.
+ * corresponding entry in the offset array filled by
+ * ::gpiod_line_request_get_requested_offsets.
* @return 0 on success, -1 on failure.
*/
int gpiod_line_request_get_values(struct gpiod_line_request *request,
* @brief Set the values of all lines associated with a request.
* @param request GPIO line request.
* @param values Array containing the values to set. Must be sized to
- * contain the number of lines returned by
- * ::gpiod_line_request_get_num_lines.
+ * contain the number of lines filled by
+ * ::gpiod_line_request_get_num_requested_lines.
* Each value is associated with the line identified by the
- * corresponding entry in the offset array returned by
- * ::gpiod_line_request_get_offsets.
+ * corresponding entry in the offset array filled by
+ * ::gpiod_line_request_get_requested_offsets.
*/
int gpiod_line_request_set_values(struct gpiod_line_request *request,
const enum gpiod_line_value *values);
#include <gpiod.h>
#include <stdlib.h>
#include <string.h>
+#include <sys/param.h>
#include "internal.h"
return NULL;
}
-GPIOD_API int gpiod_line_config_get_offsets(struct gpiod_line_config *config,
- size_t *num_offsets,
- unsigned int **offsets)
+GPIOD_API size_t
+gpiod_line_config_get_num_configured_offsets(struct gpiod_line_config *config)
{
- unsigned int *offs;
- size_t i;
-
assert(config);
- if (!num_offsets || !offsets) {
- errno = EINVAL;
- return -1;
- }
+ return config->num_configs;
+}
- *num_offsets = config->num_configs;
- *offsets = NULL;
+GPIOD_API size_t
+gpiod_line_config_get_configured_offsets(struct gpiod_line_config *config,
+ unsigned int *offsets,
+ size_t max_offsets)
+{
+ size_t num_offsets, i;
- if (!config->num_configs)
- return 0;
+ assert(config);
- offs = calloc(config->num_configs, sizeof(unsigned int));
- if (!offs)
- return -1;
+ if (!offsets || !max_offsets || !config->num_configs)
+ return 0;
- for (i = 0; i < config->num_configs; i++)
- offs[i] = config->line_configs[i].offset;
+ num_offsets = MIN(config->num_configs, max_offsets);
- *offsets = offs;
+ for (i = 0; i < num_offsets; i++)
+ offsets[i] = config->line_configs[i].offset;
- return 0;
+ return num_offsets;
}
static void set_offsets(struct gpiod_line_config *config,
#include <stdlib.h>
#include <string.h>
#include <sys/ioctl.h>
+#include <sys/param.h>
#include <unistd.h>
#include "internal.h"
}
GPIOD_API size_t
-gpiod_line_request_get_num_lines(struct gpiod_line_request *request)
+gpiod_line_request_get_num_requested_lines(struct gpiod_line_request *request)
{
assert(request);
return request->num_lines;
}
-GPIOD_API void
-gpiod_line_request_get_offsets(struct gpiod_line_request *request,
- unsigned int *offsets)
+GPIOD_API size_t
+gpiod_line_request_get_requested_offsets(struct gpiod_line_request *request,
+ unsigned int *offsets,
+ size_t max_offsets)
{
+ size_t num_offsets;
+
assert(request);
- if (!offsets)
- return;
+ if (!offsets || !max_offsets)
+ return 0;
+
+ num_offsets = MIN(request->num_lines, max_offsets);
+
+ memcpy(offsets, request->offsets, sizeof(*offsets) * num_offsets);
- memcpy(offsets, request->offsets,
- sizeof(*offsets) * request->num_lines);
+ return num_offsets;
}
GPIOD_API enum gpiod_line_value
{
g_autoptr(struct_gpiod_line_settings) settings = NULL;
g_autoptr(struct_gpiod_line_config) config = NULL;
- g_autofree guint *config_offs = NULL;
- guint offsets[8];
+ guint offsets[8], offsets_in[4];
size_t num_offsets;
- gint ret;
settings = gpiod_test_create_line_settings_or_fail();
config = gpiod_test_create_line_config_or_fail();
gpiod_test_line_config_add_line_settings_or_fail(config, offsets, 2,
settings);
- ret = gpiod_line_config_get_offsets(config, &num_offsets, &config_offs);
- g_assert_cmpint(ret, ==, 0);
+ num_offsets = gpiod_line_config_get_configured_offsets(config,
+ offsets_in, 4);
g_assert_cmpuint(num_offsets, ==, 4);
- g_assert_cmpuint(config_offs[0], ==, 2);
- g_assert_cmpuint(config_offs[1], ==, 4);
- g_assert_cmpuint(config_offs[2], ==, 6);
- g_assert_cmpuint(config_offs[3], ==, 7);
+ g_assert_cmpuint(offsets_in[0], ==, 2);
+ g_assert_cmpuint(offsets_in[1], ==, 4);
+ g_assert_cmpuint(offsets_in[2], ==, 6);
+ g_assert_cmpuint(offsets_in[3], ==, 7);
}
GPIOD_TEST_CASE(get_0_offsets)
{
g_autoptr(struct_gpiod_line_config) config = NULL;
- g_autofree guint *offsets = NULL;
size_t num_offsets;
- gint ret;
+ guint offsets[3];
config = gpiod_test_create_line_config_or_fail();
- ret = gpiod_line_config_get_offsets(config, &num_offsets, &offsets);
- g_assert_cmpint(ret, ==, 0);
+ num_offsets = gpiod_line_config_get_configured_offsets(config,
+ offsets, 0);
g_assert_cmpuint(num_offsets, ==, 0);
- g_assert_null(offsets);
}
GPIOD_TEST_CASE(get_null_offsets)
{
g_autoptr(struct_gpiod_line_config) config = NULL;
- g_autofree guint *offsets = NULL;
- gint ret;
+ size_t num_offsets;
config = gpiod_test_create_line_config_or_fail();
- ret = gpiod_line_config_get_offsets(config, NULL, &offsets);
- g_assert_cmpint(ret, ==, -1);
- gpiod_test_expect_errno(EINVAL);
+ num_offsets = gpiod_line_config_get_configured_offsets(config,
+ NULL, 10);
+ g_assert_cmpuint(num_offsets, ==, 0);
+}
+
+GPIOD_TEST_CASE(get_less_offsets_than_configured)
+{
+ static const guint offsets[] = { 0, 1, 2, 3 };
+
+ g_autoptr(struct_gpiod_line_config) config = NULL;
+ size_t num_retrieved;
+ guint retrieved[3];
+
+ config = gpiod_test_create_line_config_or_fail();
+
+ gpiod_test_line_config_add_line_settings_or_fail(config, offsets, 4,
+ NULL);
+
+ num_retrieved = gpiod_line_config_get_configured_offsets(config,
+ retrieved, 3);
+ g_assert_cmpuint(num_retrieved, ==, 3);
+ g_assert_cmpuint(retrieved[0], ==, 0);
+ g_assert_cmpuint(retrieved[1], ==, 1);
+ g_assert_cmpuint(retrieved[2], ==, 2);
+}
+
+GPIOD_TEST_CASE(get_more_offsets_than_configured)
+{
+ static const guint offsets[] = { 0, 1, 2, 3 };
+
+ g_autoptr(struct_gpiod_line_config) config = NULL;
+ size_t num_retrieved;
+ guint retrieved[8];
+
+ config = gpiod_test_create_line_config_or_fail();
+
+ gpiod_test_line_config_add_line_settings_or_fail(config, offsets, 4,
+ NULL);
+
+ num_retrieved = gpiod_line_config_get_configured_offsets(config,
+ retrieved, 8);
+ g_assert_cmpuint(num_retrieved, ==, 4);
+ g_assert_cmpuint(retrieved[0], ==, 0);
+ g_assert_cmpuint(retrieved[1], ==, 1);
+ g_assert_cmpuint(retrieved[2], ==, 2);
+ g_assert_cmpuint(retrieved[3], ==, 3);
}
request = gpiod_chip_request_lines(chip, NULL, line_cfg);
g_assert_nonnull(request);
- num_requested_offsets = gpiod_line_request_get_num_lines(request);
+ num_requested_offsets =
+ gpiod_line_request_get_num_requested_lines(request);
g_assert_cmpuint(num_requested_offsets, ==, 3);
- gpiod_line_request_get_offsets(request, requested_offsets);
+ gpiod_line_request_get_requested_offsets(request, requested_offsets, 4);
g_assert_cmpuint(requested_offsets[0], ==, 0);
g_assert_cmpuint(requested_offsets[1], ==, 2);
g_assert_cmpuint(requested_offsets[2], ==, 3);
request = gpiod_test_request_lines_or_fail(chip, NULL, line_cfg);
- g_assert_cmpuint(gpiod_line_request_get_num_lines(request), ==, 8);
+ g_assert_cmpuint(gpiod_line_request_get_num_requested_lines(request),
+ ==, 8);
gpiod_test_return_if_failed();
- gpiod_line_request_get_offsets(request, read_back);
+ gpiod_line_request_get_requested_offsets(request, read_back, 8);
for (i = 0; i < 8; i++)
g_assert_cmpuint(read_back[i], ==, offsets[i]);
}
g_assert_cmpint(g_gpiosim_chip_get_value(sim, 3), ==,
GPIOD_LINE_VALUE_ACTIVE);
}
+
+GPIOD_TEST_CASE(get_requested_offsets_less_and_more)
+{
+ static const guint offsets[] = { 0, 1, 2, 3 };
+
+ g_autoptr(GPIOSimChip) sim = g_gpiosim_chip_new("num-lines", 8, NULL);
+ g_autoptr(struct_gpiod_chip) chip = NULL;
+ g_autoptr(struct_gpiod_line_config) line_cfg = NULL;
+ g_autoptr(struct_gpiod_line_request) request = NULL;
+ size_t num_retrieved;
+ guint retrieved[6];
+
+ chip = gpiod_test_open_chip_or_fail(g_gpiosim_chip_get_dev_path(sim));
+ line_cfg = gpiod_test_create_line_config_or_fail();
+
+ gpiod_test_line_config_add_line_settings_or_fail(line_cfg, offsets, 4,
+ NULL);
+
+ request = gpiod_test_request_lines_or_fail(chip, NULL, line_cfg);
+
+ num_retrieved = gpiod_line_request_get_requested_offsets(request,
+ retrieved, 3);
+
+ g_assert_cmpuint(num_retrieved, ==, 3);
+ g_assert_cmpuint(retrieved[0], ==, 0);
+ g_assert_cmpuint(retrieved[1], ==, 1);
+ g_assert_cmpuint(retrieved[2], ==, 2);
+
+ memset(retrieved, 0, sizeof(retrieved));
+
+ num_retrieved = gpiod_line_request_get_requested_offsets(request,
+ retrieved, 6);
+
+ g_assert_cmpuint(num_retrieved, ==, 4);
+ g_assert_cmpuint(retrieved[0], ==, 0);
+ g_assert_cmpuint(retrieved[1], ==, 1);
+ g_assert_cmpuint(retrieved[2], ==, 2);
+ g_assert_cmpuint(retrieved[3], ==, 3);
+}
projects / qemu-gpiodev / libgpiod.git / commitdiff