mirror of
https://github.com/portapack-mayhem/mayhem-firmware.git
synced 2024-12-22 07:57:43 +00:00
331 lines
10 KiB
C
331 lines
10 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 templates/pal_lld.h
|
||
|
|
* @brief PAL subsystem low level driver header template.
|
||
|
|
*
|
||
|
|
* @addtogroup PAL
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef _PAL_LLD_H_
|
||
|
|
#define _PAL_LLD_H_
|
||
|
|
|
||
|
|
#if HAL_USE_PAL || defined(__DOXYGEN__)
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Unsupported modes and specific modes */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* I/O Ports Types and constants. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Generic I/O ports 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 Implementations may extend this structure to contain more,
|
||
|
|
* architecture dependent, fields.
|
||
|
|
*/
|
||
|
|
typedef struct {
|
||
|
|
|
||
|
|
} PALConfig;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Width, in bits, of an 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)0xFFFFFFFF)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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.
|
||
|
|
* @details This type can be a scalar or some kind of pointer, do not make
|
||
|
|
* any assumption about it, use the provided macros when populating
|
||
|
|
* variables of this type.
|
||
|
|
*/
|
||
|
|
typedef uint32_t ioportid_t;
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* I/O Ports Identifiers. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief First I/O port identifier.
|
||
|
|
* @details Low level drivers can define multiple ports, it is suggested to
|
||
|
|
* use this naming convention.
|
||
|
|
*/
|
||
|
|
#define IOPORT1 0
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* 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) 0
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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) 0
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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
|
||
|
|
*
|
||
|
|
* @notapi
|
||
|
|
*/
|
||
|
|
#define pal_lld_toggleport(port, bits)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Reads 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
|
||
|
|
* @return The group logical states.
|
||
|
|
*
|
||
|
|
* @notapi
|
||
|
|
*/
|
||
|
|
#define pal_lld_readgroup(port, mask, offset) 0
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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) (void)bits
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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 Reads a logical state from an I/O pad.
|
||
|
|
* @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
|
||
|
|
* @return The logical state.
|
||
|
|
* @retval PAL_LOW low logical state.
|
||
|
|
* @retval PAL_HIGH high logical state.
|
||
|
|
*
|
||
|
|
* @notapi
|
||
|
|
*/
|
||
|
|
#define pal_lld_readpad(port, pad) PAL_LOW
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Toggles a pad logical state.
|
||
|
|
* @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_togglepad(port, pad)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Pad mode setup.
|
||
|
|
* @details This function programs a pad with the specified mode.
|
||
|
|
* @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.
|
||
|
|
* @note Programming an unknown or unsupported mode is silently ignored.
|
||
|
|
*
|
||
|
|
* @param[in] port port identifier
|
||
|
|
* @param[in] pad pad number within the port
|
||
|
|
* @param[in] mode pad mode
|
||
|
|
*
|
||
|
|
* @notapi
|
||
|
|
*/
|
||
|
|
#define pal_lld_setpadmode(port, pad, mode)
|
||
|
|
|
||
|
|
#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_ */
|
||
|
|
|
||
|
|
/** @} */
|