zephyr/include/pinmux.h
Kumar Gala 789081673f Introduce new sized integer typedefs
This is a start to move away from the C99 {u}int{8,16,32,64}_t types to
Zephyr defined u{8,16,32,64}_t and s{8,16,32,64}_t.  This allows Zephyr
to define the sized types in a consistent manor across all the
architectures we support and not conflict with what various compilers
and libc might do with regards to the C99 types.

We introduce <zephyr/types.h> as part of this and have it include
<stdint.h> for now until we transition all the code away from the C99
types.

We go with u{8,16,32,64}_t and s{8,16,32,64}_t as there are some
existing variables defined u8 & u16 as well as to be consistent with
Zephyr naming conventions.

Jira: ZEP-2051

Change-Id: I451fed0623b029d65866622e478225dfab2c0ca8
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-04-20 16:07:08 +00:00

119 lines
2.4 KiB
C

/*
* Copyright (c) 2015 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* Public APIs for Pinmux drivers
*/
#ifndef __INCLUDE_PINMUX_H
#define __INCLUDE_PINMUX_H
/**
* @brief Pinmux Interface
* @defgroup pinmux_interface Pinmux Interface
* @ingroup io_interfaces
* @{
*/
#include <zephyr/types.h>
#include <device.h>
#ifdef __cplusplus
extern "C" {
#endif
#define PINMUX_FUNC_A 0
#define PINMUX_FUNC_B 1
#define PINMUX_FUNC_C 2
#define PINMUX_FUNC_D 3
#define PINMUX_PULLUP_ENABLE (0x1)
#define PINMUX_PULLUP_DISABLE (0x0)
#define PINMUX_INPUT_ENABLED (0x1)
#define PINMUX_OUTPUT_ENABLED (0x0)
/**
* @typedef pmux_set
* @brief Callback API upon setting a PIN's function
* See pinmux_pin_set() for argument description
*/
typedef int (*pmux_set)(struct device *dev, uint32_t pin, uint32_t func);
/**
* @typedef pmux_get
* @brief Callback API upon getting a PIN's function
* See pinmux_pin_get() for argument description
*/
typedef int (*pmux_get)(struct device *dev, uint32_t pin, uint32_t *func);
/**
* @typedef pmux_pullup
* @brief Callback API upon setting a PIN's pullup
* See pinmix_pin_pullup() for argument description
*/
typedef int (*pmux_pullup)(struct device *dev, uint32_t pin, uint8_t func);
/**
* @typedef pmux_input
* @brief Callback API upon setting a PIN's input function
* See pinmux_input() for argument description
*/
typedef int (*pmux_input)(struct device *dev, uint32_t pin, uint8_t func);
struct pinmux_driver_api {
pmux_set set;
pmux_get get;
pmux_pullup pullup;
pmux_input input;
};
static inline int pinmux_pin_set(struct device *dev,
uint32_t pin,
uint32_t func)
{
const struct pinmux_driver_api *api = dev->driver_api;
return api->set(dev, pin, func);
}
static inline int pinmux_pin_get(struct device *dev,
uint32_t pin,
uint32_t *func)
{
const struct pinmux_driver_api *api = dev->driver_api;
return api->get(dev, pin, func);
}
static inline int pinmux_pin_pullup(struct device *dev,
uint32_t pin,
uint8_t func)
{
const struct pinmux_driver_api *api = dev->driver_api;
return api->pullup(dev, pin, func);
}
static inline int pinmux_pin_input_enable(struct device *dev,
uint32_t pin,
uint8_t func)
{
const struct pinmux_driver_api *api = dev->driver_api;
return api->input(dev, pin, func);
}
#ifdef __cplusplus
}
#endif
/**
*
* @}
*/
#endif /* __INCLUDE_PINMUX_H */