blob: 207f4a0f4dbd83b0d9b63e4d6756bccf8e95174a [file] [log] [blame]
Philippe Reynes30d66db2020-07-24 18:19:45 +02001/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Copyright (C) 2020 Philippe Reynes <philippe.reynes@softathome.com>
4 */
5
6#ifndef __BUTTON_H
7#define __BUTTON_H
8
Neil Armstrong2d339ef2021-02-19 08:31:47 +01009struct udevice;
10
Philippe Reynes30d66db2020-07-24 18:19:45 +020011/**
12 * struct button_uc_plat - Platform data the uclass stores about each device
13 *
14 * @label: Button label
15 */
16struct button_uc_plat {
17 const char *label;
18};
19
20/**
21 * enum button_state_t - State used for button
22 * - BUTTON_OFF - Button is not pressed
23 * - BUTTON_ON - Button is pressed
24 * - BUTTON_COUNT - Number of button state
25 */
26enum button_state_t {
27 BUTTON_OFF = 0,
28 BUTTON_ON = 1,
29 BUTTON_COUNT,
30};
31
32struct button_ops {
33 /**
34 * get_state() - get the state of a button
35 *
36 * @dev: button device to change
37 * @return button state button_state_t, or -ve on error
38 */
39 enum button_state_t (*get_state)(struct udevice *dev);
Dzmitry Sankouskiea6fdc12023-01-22 18:21:24 +030040
41 /**
42 * get_code() - get linux event code of a button
43 *
44 * @dev: button device to change
45 * @return button code, or -ENODATA on error
46 */
47 int (*get_code)(struct udevice *dev);
Philippe Reynes30d66db2020-07-24 18:19:45 +020048};
49
50#define button_get_ops(dev) ((struct button_ops *)(dev)->driver->ops)
51
52/**
53 * button_get_by_label() - Find a button device by label
54 *
55 * @label: button label to look up
56 * @devp: Returns the associated device, if found
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010057 * Return: 0 if found, -ENODEV if not found, other -ve on error
Philippe Reynes30d66db2020-07-24 18:19:45 +020058 */
59int button_get_by_label(const char *label, struct udevice **devp);
60
61/**
62 * button_get_state() - get the state of a button
63 *
64 * @dev: button device to change
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010065 * Return: button state button_state_t, or -ve on error
Philippe Reynes30d66db2020-07-24 18:19:45 +020066 */
67enum button_state_t button_get_state(struct udevice *dev);
68
Dzmitry Sankouskiea6fdc12023-01-22 18:21:24 +030069/**
70 * button_get_code() - get linux event code of a button
71 *
72 * @dev: button device to change
73 * @return button code, or -ve on error
74 */
75int button_get_code(struct udevice *dev);
76
Philippe Reynes30d66db2020-07-24 18:19:45 +020077#endif