291 lines
9.2 KiB
C
291 lines
9.2 KiB
C
/*
|
|
ChibiOS/RT - Copyright (C) 2006-2013 Giovanni Di Sirio
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file LPC8xx/pal_lld.h
|
|
* @brief LPC8xx GPIO low level driver header.
|
|
*
|
|
* @addtogroup PAL
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _PAL_LLD_H_
|
|
#define _PAL_LLD_H_
|
|
|
|
#if HAL_USE_PAL || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Unsupported modes and specific modes */
|
|
/*===========================================================================*/
|
|
|
|
#undef PAL_MODE_INPUT_PULLUP
|
|
#undef PAL_MODE_INPUT_PULLDOWN
|
|
#undef PAL_MODE_INPUT_ANALOG
|
|
#undef PAL_MODE_OUTPUT_OPENDRAIN
|
|
|
|
/*===========================================================================*/
|
|
/* I/O Ports Types and constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief GPIO port setup info.
|
|
*/
|
|
|
|
/**
|
|
* @brief GPIO static initializer.
|
|
* @details An instance of this structure must be passed to @p palInit() at
|
|
* system startup time in order to initialized the digital I/O
|
|
* subsystem. This represents only the initial setup, specific pads
|
|
* or whole ports can be reprogrammed at later time.
|
|
* @note The @p IOCON block is not configured, initially all pins have
|
|
* enabled pullups and are programmed as GPIO. It is responsibility
|
|
* of the various drivers to reprogram the pins in the proper mode.
|
|
* Pins that are not handled by any driver may be programmed in
|
|
* @p board.c.
|
|
*/
|
|
typedef struct {
|
|
/** Initial value for FIO_PIN register.*/
|
|
uint32_t data;
|
|
/** Initial value for FIO_DIR register.*/
|
|
uint32_t dir;
|
|
} PALConfig;
|
|
|
|
/**
|
|
* @brief Width, in bits, of the I/O port.
|
|
*/
|
|
#define PAL_IOPORTS_WIDTH 32
|
|
|
|
/**
|
|
* @brief Whole port mask.
|
|
* @brief This macro specifies all the valid bits into a port.
|
|
*/
|
|
#define PAL_WHOLE_PORT ((ioportmask_t)0x3FFFF)
|
|
|
|
/**
|
|
* @brief Digital I/O port sized unsigned type.
|
|
*/
|
|
typedef uint32_t ioportmask_t;
|
|
|
|
/**
|
|
* @brief Digital I/O modes.
|
|
*/
|
|
typedef uint32_t iomode_t;
|
|
|
|
/**
|
|
* @brief Port Identifier.
|
|
*/
|
|
typedef LPC_GPIO_PORT_TypeDef *ioportid_t;
|
|
|
|
/*===========================================================================*/
|
|
/* I/O Ports Identifiers. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief GPIO0 port identifier.
|
|
*/
|
|
#define IOPORT1 LPC_GPIO_PORT
|
|
#define GPIO0 LPC_GPIO_PORT
|
|
|
|
|
|
/*===========================================================================*/
|
|
/* Implementation, some of the following macros could be implemented as */
|
|
/* functions, if so please put them in pal_lld.c. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Low level PAL subsystem initialization.
|
|
*
|
|
* @param[in] config architecture-dependent ports configuration
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_init(config) _pal_lld_init(config)
|
|
|
|
/**
|
|
* @brief Reads the physical I/O port states.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @return The port bits.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_readport(port) ((port)->PIN0)
|
|
|
|
/**
|
|
* @brief Reads the output latch.
|
|
* @details The purpose of this function is to read back the latched output
|
|
* value.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @return The latched logical states.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_readlatch(port) ((port)->SET0)
|
|
|
|
/**
|
|
* @brief Writes a bits mask on a I/O port.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] bits bits to be written on the specified port
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_writeport(port, bits) ((port)->PIN0 = (bits))
|
|
|
|
/**
|
|
* @brief Sets a bits mask on a I/O port.
|
|
* @note The @ref PAL provides a default software implementation of this
|
|
* functionality, implement this function if can optimize it by using
|
|
* special hardware functionalities or special coding.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] bits bits to be ORed on the specified port
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_setport(port, bits) ((port)->SET0 = (bits))
|
|
|
|
/**
|
|
* @brief Clears a bits mask on a I/O port.
|
|
* @note The @ref PAL provides a default software implementation of this
|
|
* functionality, implement this function if can optimize it by using
|
|
* special hardware functionalities or special coding.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] bits bits to be cleared on the specified port
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_clearport(port, bits) ((port)->CLR0 = (bits))
|
|
|
|
|
|
/**
|
|
* @brief Toggles a bits mask on a I/O port.
|
|
* @note The @ref PAL provides a default software implementation of this
|
|
* functionality, implement this function if can optimize it by using
|
|
* special hardware functionalities or special coding.
|
|
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] bits bits to be XORed on the specified port
|
|
*
|
|
* @api
|
|
*/
|
|
#define pal_lld_toggleport(port, bits) ((port)->NOT0 = (bits))
|
|
|
|
|
|
/**
|
|
* @brief Writes a group of bits.
|
|
* @note The @ref PAL provides a default software implementation of this
|
|
* functionality, implement this function if can optimize it by using
|
|
* special hardware functionalities or special coding.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] mask group mask
|
|
* @param[in] offset group bit offset within the port
|
|
* @param[in] bits bits to be written. Values exceeding the group width
|
|
* are masked.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_writegroup(port, mask, offset, bits) \
|
|
(port)->MASK0 = (~(mask) << (offset)); \
|
|
(port)->MPIN0 = ((bits) << (offset))
|
|
|
|
/**
|
|
* @brief Pads group mode setup.
|
|
* @details This function programs a pads group belonging to the same port
|
|
* with the specified mode.
|
|
* @note Programming an unknown or unsupported mode is silently ignored.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] mask group mask
|
|
* @param[in] offset group bit offset within the port
|
|
* @param[in] mode group mode
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_setgroupmode(port, mask, offset, mode) \
|
|
_pal_lld_setgroupmode(port, mask << offset, mode)
|
|
|
|
/**
|
|
* @brief Writes a logical state on an output pad.
|
|
* @note This function is not meant to be invoked directly by the
|
|
* application code.
|
|
* @note The @ref PAL provides a default software implementation of this
|
|
* functionality, implement this function if can optimize it by using
|
|
* special hardware functionalities or special coding.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] pad pad number within the port
|
|
* @param[in] bit logical value, the value must be @p PAL_LOW or
|
|
* @p PAL_HIGH
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_writepad(port, pad, bit) \
|
|
((port)->W0[(pad)] = (bit))
|
|
|
|
/**
|
|
* @brief Sets a pad logical state to @p PAL_HIGH.
|
|
* @note The @ref PAL provides a default software implementation of this
|
|
* functionality, implement this function if can optimize it by using
|
|
* special hardware functionalities or special coding.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] pad pad number within the port
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_setpad(port, pad) \
|
|
((port)->W0[(pad)] = 1)
|
|
|
|
/**
|
|
* @brief Clears a pad logical state to @p PAL_LOW.
|
|
* @note The @ref PAL provides a default software implementation of this
|
|
* functionality, implement this function if can optimize it by using
|
|
* special hardware functionalities or special coding.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] pad pad number within the port
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_clearpad(port, pad) \
|
|
((port)->W0[(pad)] = 0)
|
|
|
|
#if !defined(__DOXYGEN__)
|
|
extern const PALConfig pal_default_config;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void _pal_lld_init(const PALConfig *config);
|
|
void _pal_lld_setgroupmode(ioportid_t port,
|
|
ioportmask_t mask,
|
|
iomode_t mode);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_PAL */
|
|
|
|
#endif /* _PAL_LLD_H_ */
|
|
|
|
/** @} */
|