171 lines
5.6 KiB
C
171 lines
5.6 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_sio_lld.h
|
|
* @brief PLATFORM SIO subsystem low level driver header.
|
|
*
|
|
* @addtogroup SIO
|
|
* @{
|
|
*/
|
|
|
|
#ifndef HAL_SIO_LLD_H
|
|
#define HAL_SIO_LLD_H
|
|
|
|
#if (HAL_USE_SIO == TRUE) || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name PLATFORM configuration options
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief SIO driver enable switch.
|
|
* @details If set to @p TRUE the support for SIO1 is included.
|
|
* @note The default is @p FALSE.
|
|
*/
|
|
#if !defined(PLATFORM_SIO_USE_SIO1) || defined(__DOXYGEN__)
|
|
#define PLATFORM_SIO_USE_SIO1 FALSE
|
|
#endif
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Low level fields of the SIO driver structure.
|
|
*/
|
|
#define sio_lld_driver_fields \
|
|
uint32_t dummy
|
|
|
|
/**
|
|
* @brief Low level fields of the SIO configuration structure.
|
|
*/
|
|
#define sio_lld_config_fields \
|
|
uint32_t dummy
|
|
|
|
/**
|
|
* @brief Determines the state of the RX FIFO.
|
|
*
|
|
* @param[in] siop pointer to the @p SIODriver object
|
|
* @return The RX FIFO state.
|
|
* @retval false if RX FIFO is not empty
|
|
* @retval true if RX FIFO is empty
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define sio_lld_is_rx_empty(siop) false
|
|
|
|
/**
|
|
* @brief Determines the activity state of the receiver.
|
|
*
|
|
* @param[in] siop pointer to the @p SIODriver object
|
|
* @return The RX activity state.
|
|
* @retval false if RX is in active state.
|
|
* @retval true if RX is in idle state.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define sio_lld_is_rx_idle(siop) false
|
|
|
|
/**
|
|
* @brief Determines if RX has pending error events to be read and cleared.
|
|
* @note Only error and protocol errors are handled, data events are not
|
|
* considered.
|
|
*
|
|
* @param[in] siop pointer to the @p SIODriver object
|
|
* @return The RX error events.
|
|
* @retval false if RX has no pending events
|
|
* @retval true if RX has pending events
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define sio_lld_has_rx_errors(siop) false
|
|
|
|
/**
|
|
* @brief Determines the state of the TX FIFO.
|
|
*
|
|
* @param[in] siop pointer to the @p SIODriver object
|
|
* @return The TX FIFO state.
|
|
* @retval false if TX FIFO is not full
|
|
* @retval true if TX FIFO is full
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define sio_lld_is_tx_full(siop) false
|
|
|
|
/**
|
|
* @brief Determines the transmission state.
|
|
*
|
|
* @param[in] siop pointer to the @p SIODriver object
|
|
* @return The TX FIFO state.
|
|
* @retval false if transmission is idle
|
|
* @retval true if transmission is ongoing
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define sio_lld_is_tx_ongoing(siop) false
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if (PLATFORM_SIO_USE_SIO1 == TRUE) && !defined(__DOXYGEN__)
|
|
extern SIODriver SIOD1;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void sio_lld_init(void);
|
|
msg_t sio_lld_start(SIODriver *siop);
|
|
void sio_lld_stop(SIODriver *siop);
|
|
void sio_lld_update_enable_flags(SIODriver *siop);
|
|
sioevents_t sio_lld_get_and_clear_errors(SIODriver *siop);
|
|
sioevents_t sio_lld_get_and_clear_events(SIODriver *siop);
|
|
sioevents_t sio_lld_get_events(SIODriver *siop);
|
|
size_t sio_lld_read(SIODriver *siop, uint8_t *buffer, size_t n);
|
|
size_t sio_lld_write(SIODriver *siop, const uint8_t *buffer, size_t n);
|
|
msg_t sio_lld_get(SIODriver *siop);
|
|
void sio_lld_put(SIODriver *siop, uint_fast16_t data);
|
|
msg_t sio_lld_control(SIODriver *siop, unsigned int operation, void *arg);
|
|
void sio_lld_serve_interrupt(SIODriver *siop);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_SIO == TRUE */
|
|
|
|
#endif /* HAL_SIO_LLD_H */
|
|
|
|
/** @} */
|