Zephyr Project API  3.2.0
A Scalable Open Source RTOS
pinmux.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2015 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_DRIVERS_PINMUX_H_
13#define ZEPHYR_INCLUDE_DRIVERS_PINMUX_H_
14
22#include <zephyr/types.h>
23#include <zephyr/device.h>
24#include <zephyr/toolchain.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30#define PINMUX_FUNC_A 0
31#define PINMUX_FUNC_B 1
32#define PINMUX_FUNC_C 2
33#define PINMUX_FUNC_D 3
34#define PINMUX_FUNC_E 4
35#define PINMUX_FUNC_F 5
36#define PINMUX_FUNC_G 6
37#define PINMUX_FUNC_H 7
38#define PINMUX_FUNC_I 8
39#define PINMUX_FUNC_J 9
40#define PINMUX_FUNC_K 10
41#define PINMUX_FUNC_L 11
42#define PINMUX_FUNC_M 12
43#define PINMUX_FUNC_N 13
44#define PINMUX_FUNC_O 14
45#define PINMUX_FUNC_P 15
46
47#define PINMUX_PULLUP_ENABLE (0x1)
48#define PINMUX_PULLUP_DISABLE (0x0)
49
50#define PINMUX_INPUT_ENABLED (0x1)
51#define PINMUX_OUTPUT_ENABLED (0x0)
52
58typedef int (*pmux_set)(const struct device *dev, uint32_t pin, uint32_t func);
64typedef int (*pmux_get)(const struct device *dev, uint32_t pin,
65 uint32_t *func);
71typedef int (*pmux_pullup)(const struct device *dev, uint32_t pin,
72 uint8_t func);
78typedef int (*pmux_input)(const struct device *dev, uint32_t pin,
79 uint8_t func);
80
81__subsystem struct pinmux_driver_api {
86};
87
88__deprecated static inline int pinmux_pin_set(const struct device *dev,
89 uint32_t pin, uint32_t func)
90{
91 const struct pinmux_driver_api *api =
92 (const struct pinmux_driver_api *)dev->api;
93
94 return api->set(dev, pin, func);
95}
96
97__deprecated static inline int pinmux_pin_get(const struct device *dev,
98 uint32_t pin, uint32_t *func)
99{
100 const struct pinmux_driver_api *api =
101 (const struct pinmux_driver_api *)dev->api;
102
103 return api->get(dev, pin, func);
104}
105
106__deprecated static inline int pinmux_pin_pullup(const struct device *dev,
107 uint32_t pin, uint8_t func)
108{
109 const struct pinmux_driver_api *api =
110 (const struct pinmux_driver_api *)dev->api;
111
112 return api->pullup(dev, pin, func);
113}
114
115__deprecated static inline int pinmux_pin_input_enable(const struct device *dev,
116 uint32_t pin,
117 uint8_t func)
118{
119 const struct pinmux_driver_api *api =
120 (const struct pinmux_driver_api *)dev->api;
121
122 return api->input(dev, pin, func);
123}
124
125#ifdef __cplusplus
126}
127#endif
128
134#endif /* ZEPHYR_INCLUDE_DRIVERS_PINMUX_H_ */
static int pinmux_pin_input_enable(const struct device *dev, uint32_t pin, uint8_t func)
Definition: pinmux.h:115
int(* pmux_set)(const struct device *dev, uint32_t pin, uint32_t func)
Callback API upon setting a PIN's function See pinmux_pin_set() for argument description.
Definition: pinmux.h:58
int(* pmux_get)(const struct device *dev, uint32_t pin, uint32_t *func)
Callback API upon getting a PIN's function See pinmux_pin_get() for argument description.
Definition: pinmux.h:64
int(* pmux_input)(const struct device *dev, uint32_t pin, uint8_t func)
Callback API upon setting a PIN's input function See pinmux_input() for argument description.
Definition: pinmux.h:78
static int pinmux_pin_get(const struct device *dev, uint32_t pin, uint32_t *func)
Definition: pinmux.h:97
static int pinmux_pin_set(const struct device *dev, uint32_t pin, uint32_t func)
Definition: pinmux.h:88
static int pinmux_pin_pullup(const struct device *dev, uint32_t pin, uint8_t func)
Definition: pinmux.h:106
int(* pmux_pullup)(const struct device *dev, uint32_t pin, uint8_t func)
Callback API upon setting a PIN's pullup See pinmix_pin_pullup() for argument description.
Definition: pinmux.h:71
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
Runtime device structure (in ROM) per driver instance.
Definition: device.h:435
const void * api
Definition: device.h:441
Definition: pinmux.h:81
pmux_set set
Definition: pinmux.h:82
pmux_input input
Definition: pinmux.h:85
pmux_get get
Definition: pinmux.h:83
pmux_pullup pullup
Definition: pinmux.h:84
Macros to abstract toolchain specific capabilities.