118 lines
4.5 KiB
C
118 lines
4.5 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/serial_lld.h
|
||
|
|
* @brief Serial Driver subsystem low level driver header template.
|
||
|
|
*
|
||
|
|
* @addtogroup SERIAL
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef _SERIAL_LLD_H_
|
||
|
|
#define _SERIAL_LLD_H_
|
||
|
|
|
||
|
|
#if HAL_USE_SERIAL || defined(__DOXYGEN__)
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Driver constants. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Driver pre-compile time settings. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name Configuration options
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @brief SD1 driver enable switch.
|
||
|
|
* @details If set to @p TRUE the support for SD1 is included.
|
||
|
|
*/
|
||
|
|
#if !defined(PLATFORM_SERIAL_USE_SD1) || defined(__DOXYGEN__)
|
||
|
|
#define PLATFORM_SERIAL_USE_SD1 FALSE
|
||
|
|
#endif
|
||
|
|
/** @} */
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Derived constants and error checks. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Driver data structures and types. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Generic Serial Driver configuration structure.
|
||
|
|
* @details An instance of this structure must be passed to @p sdStart()
|
||
|
|
* in order to configure and start a serial driver operations.
|
||
|
|
* @note Implementations may extend this structure to contain more,
|
||
|
|
* architecture dependent, fields.
|
||
|
|
*/
|
||
|
|
typedef struct {
|
||
|
|
/**
|
||
|
|
* @brief Bit rate.
|
||
|
|
*/
|
||
|
|
uint32_t sc_speed;
|
||
|
|
/* End of the mandatory fields.*/
|
||
|
|
} SerialConfig;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief @p SerialDriver specific data.
|
||
|
|
*/
|
||
|
|
#define _serial_driver_data \
|
||
|
|
_base_asynchronous_channel_data \
|
||
|
|
/* Driver state.*/ \
|
||
|
|
sdstate_t state; \
|
||
|
|
/* Input queue.*/ \
|
||
|
|
InputQueue iqueue; \
|
||
|
|
/* Output queue.*/ \
|
||
|
|
OutputQueue oqueue; \
|
||
|
|
/* Input circular buffer.*/ \
|
||
|
|
uint8_t ib[SERIAL_BUFFERS_SIZE]; \
|
||
|
|
/* Output circular buffer.*/ \
|
||
|
|
uint8_t ob[SERIAL_BUFFERS_SIZE]; \
|
||
|
|
/* End of the mandatory fields.*/
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* Driver macros. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
/*===========================================================================*/
|
||
|
|
/* External declarations. */
|
||
|
|
/*===========================================================================*/
|
||
|
|
|
||
|
|
#if PLATFORM_SERIAL_USE_SD1 && !defined(__DOXYGEN__)
|
||
|
|
extern SerialDriver SD1;
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
void sd_lld_init(void);
|
||
|
|
void sd_lld_start(SerialDriver *sdp, const SerialConfig *config);
|
||
|
|
void sd_lld_stop(SerialDriver *sdp);
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* HAL_USE_SERIAL */
|
||
|
|
|
||
|
|
#endif /* _SERIAL_LLD_H_ */
|
||
|
|
|
||
|
|
/** @} */
|