Zephyr API Documentation  3.0.0
A Scalable Open Source RTOS
3.0.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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 <device.h>
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29#define PINMUX_FUNC_A 0
30#define PINMUX_FUNC_B 1
31#define PINMUX_FUNC_C 2
32#define PINMUX_FUNC_D 3
33#define PINMUX_FUNC_E 4
34#define PINMUX_FUNC_F 5
35#define PINMUX_FUNC_G 6
36#define PINMUX_FUNC_H 7
37#define PINMUX_FUNC_I 8
38#define PINMUX_FUNC_J 9
39#define PINMUX_FUNC_K 10
40#define PINMUX_FUNC_L 11
41#define PINMUX_FUNC_M 12
42#define PINMUX_FUNC_N 13
43#define PINMUX_FUNC_O 14
44#define PINMUX_FUNC_P 15
45
46#define PINMUX_PULLUP_ENABLE (0x1)
47#define PINMUX_PULLUP_DISABLE (0x0)
48
49#define PINMUX_INPUT_ENABLED (0x1)
50#define PINMUX_OUTPUT_ENABLED (0x0)
51
57typedef int (*pmux_set)(const struct device *dev, uint32_t pin, uint32_t func);
63typedef int (*pmux_get)(const struct device *dev, uint32_t pin,
64 uint32_t *func);
70typedef int (*pmux_pullup)(const struct device *dev, uint32_t pin,
71 uint8_t func);
77typedef int (*pmux_input)(const struct device *dev, uint32_t pin,
78 uint8_t func);
79
80__subsystem struct pinmux_driver_api {
85};
86
87static inline int pinmux_pin_set(const struct device *dev, uint32_t pin,
88 uint32_t func)
89{
90 const struct pinmux_driver_api *api =
91 (const struct pinmux_driver_api *)dev->api;
92
93 return api->set(dev, pin, func);
94}
95
96static inline int pinmux_pin_get(const struct device *dev, uint32_t pin,
97 uint32_t *func)
98{
99 const struct pinmux_driver_api *api =
100 (const struct pinmux_driver_api *)dev->api;
101
102 return api->get(dev, pin, func);
103}
104
105static inline int pinmux_pin_pullup(const struct device *dev, uint32_t pin,
106 uint8_t func)
107{
108 const struct pinmux_driver_api *api =
109 (const struct pinmux_driver_api *)dev->api;
110
111 return api->pullup(dev, pin, func);
112}
113
114static inline int pinmux_pin_input_enable(const struct device *dev,
115 uint32_t pin,
116 uint8_t func)
117{
118 const struct pinmux_driver_api *api =
119 (const struct pinmux_driver_api *)dev->api;
120
121 return api->input(dev, pin, func);
122}
123
124#ifdef __cplusplus
125}
126#endif
127
133#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:114
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:57
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:63
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:77
static int pinmux_pin_get(const struct device *dev, uint32_t pin, uint32_t *func)
Definition: pinmux.h:96
static int pinmux_pin_set(const struct device *dev, uint32_t pin, uint32_t func)
Definition: pinmux.h:87
static int pinmux_pin_pullup(const struct device *dev, uint32_t pin, uint8_t func)
Definition: pinmux.h:105
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:70
__UINT32_TYPE__ uint32_t
Definition: stdint.h:60
__UINT8_TYPE__ uint8_t
Definition: stdint.h:58
Runtime device structure (in ROM) per driver instance.
Definition: device.h:450
const void * api
Definition: device.h:456
Definition: pinmux.h:80
pmux_set set
Definition: pinmux.h:81
pmux_input input
Definition: pinmux.h:84
pmux_get get
Definition: pinmux.h:82
pmux_pullup pullup
Definition: pinmux.h:83