mirror of
https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git
synced 2026-10-24 00:48:53 +03:00
0fe66719dd
Reuse as much of the functionality provided by the new libgpiotools shared library in tools-common while retaining the functions used to validate command-line arguments, print help text or bail-out on errors. We keep the existing interfaces to gpio-tools and use them to wrap the API exposed by libgpiotools as we want to keep bailing out on errors without requiring tools to do a lot of repeated error checking. Acked-by: Kent Gibson <warthog618@gmail.com> Link: https://patch.msgid.link/20260513-tools-common-shared-lib-v1-2-58ac28a9f1d5@oss.qualcomm.com Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
75 lines
2.9 KiB
C
75 lines
2.9 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
/* SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> */
|
|
/* SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> */
|
|
|
|
#ifndef __GPIOD_TOOLS_COMMON_H__
|
|
#define __GPIOD_TOOLS_COMMON_H__
|
|
|
|
#include <gpiod.h>
|
|
|
|
#include "gpiotools.h"
|
|
|
|
/*
|
|
* Various helpers for the GPIO tools.
|
|
*
|
|
* NOTE: This is not a stable interface - it's only to avoid duplicating
|
|
* common code.
|
|
*/
|
|
|
|
#define NORETURN __attribute__((noreturn))
|
|
#define PRINTF(fmt, arg) __attribute__((format(printf, fmt, arg)))
|
|
|
|
#define GETOPT_NULL_LONGOPT NULL, 0, NULL, 0
|
|
|
|
#define resolved_line gpiotools_resolved_line
|
|
#define resolved_chip gpiotools_resolved_chip
|
|
#define line_resolver gpiotools_line_resolver
|
|
|
|
void set_prog_name(const char *name);
|
|
const char *get_prog_name(void);
|
|
const char *get_prog_short_name(void);
|
|
void print_error(const char *fmt, ...) PRINTF(1, 2);
|
|
void print_perror(const char *fmt, ...) PRINTF(1, 2);
|
|
void die(const char *fmt, ...) NORETURN PRINTF(1, 2);
|
|
void die_oom(void) NORETURN;
|
|
void die_perror(const char *fmt, ...) NORETURN PRINTF(1, 2);
|
|
void print_version(void);
|
|
int parse_bias_or_die(const char *option);
|
|
long long parse_period(const char *option);
|
|
unsigned long long parse_period_or_die(const char *option);
|
|
void sleep_us(unsigned long long period);
|
|
int parse_uint(const char *option);
|
|
unsigned int parse_uint_or_die(const char *option);
|
|
void print_bias_help(void);
|
|
void print_chip_help(void);
|
|
void print_period_help(void);
|
|
void print_event_time(uint64_t evtime, int format);
|
|
void print_line_attributes(struct gpiod_line_info *info, bool unquoted_strings);
|
|
void print_line_id(struct line_resolver *resolver, int chip_num,
|
|
unsigned int offset, const char *chip_id, bool unquoted);
|
|
void print_line_vals(struct line_resolver *resolver, bool is_unquoted,
|
|
bool is_numeric);
|
|
bool chip_path_lookup(const char *id, char **path_ptr);
|
|
int chip_paths(const char *id, char ***paths_ptr);
|
|
int all_chip_paths(char ***paths_ptr);
|
|
struct line_resolver *resolve_lines(int num_lines, char **lines,
|
|
const char *chip_id, bool strict,
|
|
bool by_name);
|
|
struct line_resolver *resolver_init(int num_lines, char **lines, int num_chips,
|
|
bool strict, bool by_name);
|
|
bool resolve_lines_by_offset(struct line_resolver *resolver,
|
|
unsigned int num_lines);
|
|
bool resolve_done(struct line_resolver *resolver);
|
|
void validate_resolution(struct line_resolver *resolver, const char *chip_id);
|
|
void free_line_resolver(struct line_resolver *resolver);
|
|
int get_line_offsets_and_values(struct line_resolver *resolver, int chip_num,
|
|
unsigned int *offsets,
|
|
enum gpiod_line_value *values);
|
|
const char *get_chip_name(struct line_resolver *resolver, int chip_num);
|
|
const char *get_line_name(struct line_resolver *resolver, int chip_num,
|
|
unsigned int offset);
|
|
void set_line_values(struct line_resolver *resolver, int chip_num,
|
|
enum gpiod_line_value *values);
|
|
|
|
#endif /* __GPIOD_TOOLS_COMMON_H__ */
|