268 lines
7 KiB
C
268 lines
7 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2018 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 hal_pal_lld.h
|
|
* @brief Simulator low level PAL driver header.
|
|
*
|
|
* @addtogroup SIMULATOR_PAL
|
|
* @{
|
|
*/
|
|
|
|
#ifndef HAL_PAL_LLD_H
|
|
#define HAL_PAL_LLD_H
|
|
|
|
#if (HAL_USE_PAL == TRUE) || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Unsupported modes and specific modes */
|
|
/*===========================================================================*/
|
|
|
|
#undef PAL_MODE_INPUT_PULLUP
|
|
#undef PAL_MODE_INPUT_PULLDOWN
|
|
#undef PAL_MODE_OUTPUT_OPENDRAIN
|
|
#undef PAL_MODE_INPUT_ANALOG
|
|
|
|
/*===========================================================================*/
|
|
/* I/O Ports Types and constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief VIO port structure.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief VIO_LATCH register.
|
|
* @details This register represents the output latch of the VIO port.
|
|
*/
|
|
uint32_t latch;
|
|
/**
|
|
* @brief VIO_PIN register.
|
|
* @details This register represents the logical level at the VIO port
|
|
* pin level.
|
|
*/
|
|
uint32_t pin;
|
|
/**
|
|
* @brief VIO_DIR register.
|
|
* @details Direction of the VIO port bits, 0=input, 1=output.
|
|
*/
|
|
uint32_t dir;
|
|
} sim_vio_port_t;
|
|
|
|
/**
|
|
* @brief Virtual 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.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Virtual port 1 setup data.
|
|
*/
|
|
sim_vio_port_t VP1Data;
|
|
/**
|
|
* @brief Virtual port 2 setup data.
|
|
*/
|
|
sim_vio_port_t VP2Data;
|
|
} PALConfig;
|
|
|
|
/**
|
|
* @brief Width, in bits, of an I/O port.
|
|
*/
|
|
#define PAL_IOPORTS_WIDTH 32
|
|
|
|
/**
|
|
* @brief Whole port mask.
|
|
* @details This macro specifies all the valid bits into a port.
|
|
*/
|
|
#define PAL_WHOLE_PORT ((ioportmask_t)0xFFFFFFFFU)
|
|
/** @} */
|
|
|
|
/**
|
|
* @name Line handling macros
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Forms a line identifier.
|
|
* @details A port/pad pair are encoded into an @p ioline_t type. The encoding
|
|
* of this type is platform-dependent.
|
|
*/
|
|
#define PAL_LINE(port, pad) \
|
|
((ioline_t)((uint32_t)(port)) | ((uint32_t)(pad)))
|
|
|
|
/**
|
|
* @brief Decodes a port identifier from a line identifier.
|
|
*/
|
|
#define PAL_PORT(line) \
|
|
((sim_vio_port_t *)(((uint32_t)(line)) & 0xFFFFFFF0U))
|
|
|
|
/**
|
|
* @brief Decodes a pad identifier from a line identifier.
|
|
*/
|
|
#define PAL_PAD(line) \
|
|
((uint32_t)((uint32_t)(line) & 0x0000000FU))
|
|
|
|
/**
|
|
* @brief Value identifying an invalid line.
|
|
*/
|
|
#define PAL_NOLINE 0U
|
|
/** @} */
|
|
|
|
/**
|
|
* @brief Digital I/O port sized unsigned type.
|
|
*/
|
|
typedef uint32_t ioportmask_t;
|
|
|
|
/**
|
|
* @brief Digital I/O modes.
|
|
*/
|
|
typedef uint32_t iomode_t;
|
|
|
|
/**
|
|
* @brief Type of an I/O line.
|
|
*/
|
|
typedef uint32_t ioline_t;
|
|
|
|
/**
|
|
* @brief Port Identifier.
|
|
*/
|
|
typedef sim_vio_port_t * ioportid_t;
|
|
|
|
/**
|
|
* @brief Type of an pad identifier.
|
|
*/
|
|
typedef uint32_t iopadid_t;
|
|
|
|
/*===========================================================================*/
|
|
/* I/O Ports Identifiers. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief VIO port 1 identifier.
|
|
*/
|
|
#define IOPORT1 (&vio_port_1)
|
|
|
|
/**
|
|
* @brief VIO port 2 identifier.
|
|
*/
|
|
#define IOPORT2 (&vio_port_2)
|
|
|
|
/*===========================================================================*/
|
|
/* 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) \
|
|
(vio_port_1 = (config)->VP1Data, \
|
|
vio_port_2 = (config)->VP2Data)
|
|
|
|
/**
|
|
* @brief Reads the physical I/O port states.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @return The port bits.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_readport(port) ((port)->pin)
|
|
|
|
/**
|
|
* @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)->latch)
|
|
|
|
/**
|
|
* @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)->latch = (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 Returns a PAL event structure associated to a pad.
|
|
*
|
|
* @param[in] port port identifier
|
|
* @param[in] pad pad number within the port
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_get_pad_event(port, pad) NULL; (void)(port); (void)pad
|
|
|
|
/**
|
|
* @brief Returns a PAL event structure associated to a line.
|
|
*
|
|
* @param[in] line line identifier
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define pal_lld_get_line_event(line) NULL; (void)line
|
|
|
|
#if !defined(__DOXYGEN__)
|
|
extern sim_vio_port_t vio_port_1;
|
|
extern sim_vio_port_t vio_port_2;
|
|
extern const PALConfig pal_default_config;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void _pal_lld_setgroupmode(ioportid_t port,
|
|
ioportmask_t mask,
|
|
iomode_t mode);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_PAL == TRUE */
|
|
|
|
#endif /* HAL_PAL_LLD_H */
|
|
|
|
/** @} */
|