ConOpSys V2970  P004.07
ANVILEX control operating system
UART1_P014_51_CB.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file UART1_P014_51_CB.h
3 //! @brief Control board P015.27 CB STM32F429 on-chip UART1 hardware driver header file.
4 //! @attention No special attention requered.
5 //! @copyright (C) 2015-2020 ANVILEX LLC
6 //! $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P015_09_V1_0/CAN1_P015_09_CB.h $
7 //! $Revision: 2262 $
8 //! $Date: 2020-12-05 07:20:48 +0500 (Sa, 05 Dez 2020) $
9 //! $Author: minch $
10 //------------------------------------------------------------------------------
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are met:
14 //
15 // 1. Redistributions of source code must retain the above copyright notice,
16 // this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright notice,
19 // this list of conditions and the following disclaimer in the documentation
20 // and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of ANVILEX nor the names of its contributors may be
23 // used to endorse or promote products derived from this software without
24 // specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
30 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 // POSSIBILITY OF SUCH DAMAGE.
37 //
38 //------------------------------------------------------------------------------
39 
40 //------------------------------------------------------------------------------
41 // Protecting header files from mutual, recursive inclusion.
42 //------------------------------------------------------------------------------
43 
44 #pragma once
45 
46 //------------------------------------------------------------------------------
47 // System includes
48 //------------------------------------------------------------------------------
49 
50 #include "UART1_STM32F429.h"
51 
52 //------------------------------------------------------------------------------
53 // Project includes
54 //------------------------------------------------------------------------------
55 
56 //------------------------------------------------------------------------------
57 // forward references
58 //------------------------------------------------------------------------------
59 
60 //------------------------------------------------------------------------------
61 // macros
62 //------------------------------------------------------------------------------
63 
64 //------------------------------------------------------------------------------
65 // enums
66 //------------------------------------------------------------------------------
67 
68 //------------------------------------------------------------------------------
69 // Defines
70 //------------------------------------------------------------------------------
71 
72 #define UART1_TX_BUFFER_SIZE 256
73 
74 //------------------------------------------------------------------------------
75 // Define command strings
76 //------------------------------------------------------------------------------
77 
78 //------------------------------------------------------------------------------
79 // Struct
80 //------------------------------------------------------------------------------
81 
82 //------------------------------------------------------------------------------
83 // Externe variables
84 //------------------------------------------------------------------------------
85 
86 //------------------------------------------------------------------------------
87 // Function prototypes
88 //------------------------------------------------------------------------------
89 
90 //------------------------------------------------------------------------------
91 // Export variables
92 //------------------------------------------------------------------------------
93 
94 //------------------------------------------------------------------------------
95 // TSystem_UART class
96 //------------------------------------------------------------------------------
97 
98 //! @brief STM32F429 on-chip UART1 hardware abstraction layer class for P014_51_CB.
100 {
101 
102  //----------------------------------------------------------------------------
103  // Public defines, methods and variables
104  //----------------------------------------------------------------------------
105 
106  public:
107 
108  //--------------------------------------------------------------------------
109  // Object initialisation and finalisation methods
110  //--------------------------------------------------------------------------
111 
112  //!-------------------------------------------------------------------------
113  //! @brief PIO initialisation method
114  //! @note None
115  //! @return None
116  //! \par Override
117  //! Not allowed
118  //! @attention None
119  //--------------------------------------------------------------------------
120 
121  virtual VOID PIO_Init();
122 
123  //!-------------------------------------------------------------------------
124  //! @brief PIO reinitialisation as GPIO method
125  //! @note None
126  //! @return None
127  //! \par Override
128  //! Not allowed
129  //! @attention None
130  //--------------------------------------------------------------------------
131 
132  virtual VOID PIO_Done();
133 
134  //----------------------------------------------------------------------------
135  // Protected defines, methods and variables
136  //----------------------------------------------------------------------------
137 
138  protected:
139 
140 
141  //----------------------------------------------------------------------------
142  // Private methods, variables and definitions
143  //----------------------------------------------------------------------------
144 
145  private:
146 
147  //--------------------------------------------------------------------------
148  // Private type definitions
149  //--------------------------------------------------------------------------
150 
151 };
152 
153 //------------------------------------------------------------------------------
154 // End Of File
155 //------------------------------------------------------------------------------
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
STM32F429 on-chip UART1 module class header file.
STM32F429 on-chip UART1 hardware abstraction layer class for P014_51_CB.
Definition: UART1_P014_51_CB.h:100
virtual VOID PIO_Done()
PIO reinitialisation as GPIO method.
Definition: UART1_P014_51_CB.cpp:137
virtual VOID PIO_Init()
PIO initialisation method.
Definition: UART1_P014_51_CB.cpp:112
STM32F429 on-chip UART1 hardware abstraction layer class.
Definition: UART1_STM32F429.h:62