include/bsp/hsu.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup lpc32xx_hsu
0007  *
0008  * @brief HSU support API.
0009  */
0010
0011 /*
0012  * Copyright (C) 2010, 2014 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #ifndef LIBBSP_ARM_LPC32XX_HSU_H
0037 #define LIBBSP_ARM_LPC32XX_HSU_H
0038
0039 #include <rtems/termiostypes.h>
0040
0041 #ifdef __cplusplus
0042 extern "C" {
0043 #endif /* __cplusplus */
0044
0045 /**
0046  * @defgroup lpc32xx_hsu HSU Support
0047  *
0048  * @ingroup RTEMSBSPsARMLPC32XX
0049  *
0050  * @brief HSU Support
0051  *
0052  * @{
0053  */
0054
0055 typedef struct {
0056   uint32_t fifo;
0057   uint32_t level;
0058   uint32_t iir;
0059   uint32_t ctrl;
0060   uint32_t rate;
0061 } lpc32xx_hsu;
0062
0063 typedef struct {
0064   rtems_termios_device_context base;
0065   volatile lpc32xx_hsu *hsu;
0066   size_t chars_in_transmission;
0067   rtems_vector_number irq;
0068   uint32_t initial_baud;
0069 } lpc32xx_hsu_context;
0070
0071 extern const rtems_termios_device_handler lpc32xx_hsu_fns;
0072
0073 bool lpc32xx_hsu_probe(rtems_termios_device_context *base);
0074
0075 /** @} */
0076
0077 #ifdef __cplusplus
0078 }
0079 #endif /* __cplusplus */
0080
0081 #endif /* LIBBSP_ARM_LPC32XX_HSU_H */