ConOpSys V2970  P004.07
ANVILEX control operating system
UART6_P015_09_CB.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file UART6_P015_09_CB.h
3 //! @brief Control board P015.09 CB STM32F429 on-chip UART6 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/UART6_P015_09_CB.h $
7 //! $Revision: 2572 $
8 //! $Date: 2021-04-02 14:20:42 +0500 (Fr, 02 Apr 2021) $
9 //! $Author: ggavrituhin $
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 "UART6_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 //------------------------------------------------------------------------------
73 // Define command strings
74 //------------------------------------------------------------------------------
75 
76 //------------------------------------------------------------------------------
77 // Struct
78 //------------------------------------------------------------------------------
79 
80 //------------------------------------------------------------------------------
81 // Externe variables
82 //------------------------------------------------------------------------------
83 
84 //------------------------------------------------------------------------------
85 // Function prototypes
86 //------------------------------------------------------------------------------
87 
88 //------------------------------------------------------------------------------
89 // Export variables
90 //------------------------------------------------------------------------------
91 
92 //------------------------------------------------------------------------------
93 // TSystem_UART class
94 //------------------------------------------------------------------------------
95 
96 //! @brief STM32F429 on-chip UART6 hardware abstraction layer class for P015_09_CB.
98 {
99 
100  //----------------------------------------------------------------------------
101  // Public defines, methods and variables
102  //----------------------------------------------------------------------------
103 
104  public:
105 
106  //--------------------------------------------------------------------------
107  // Object initialisation and finalisation methods
108  //--------------------------------------------------------------------------
109 
110  //!-------------------------------------------------------------------------
111  //! @brief PIO initialisation method
112  //! @note None
113  //! @return None
114  //! \par Override
115  //! Not allowed
116  //! @attention None
117  //--------------------------------------------------------------------------
118 
119  virtual VOID PIO_Init();
120 
121  //!-------------------------------------------------------------------------
122  //! @brief PIO reinitialization as GPIO method
123  //! @note None
124  //! @return None
125  //! \par Override
126  //! Not allowed
127  //! @attention None
128  //--------------------------------------------------------------------------
129 
130  virtual VOID PIO_Done();
131 
132  //!-------------------------------------------------------------------------
133  //! @brief Set transmit mode method.
134  //! @note None
135  //! @return None
136  //! \par Override
137  //! Not allowed
138  //! @attention None
139  //--------------------------------------------------------------------------
140 
141  virtual VOID Set_Transmit_Mode();
142 
143  //!-------------------------------------------------------------------------
144  //! @brief Set receive mode method.
145  //! @note None
146  //! @return None
147  //! \par Override
148  //! Not allowed
149  //! @attention None
150  //--------------------------------------------------------------------------
151 
152  virtual VOID Set_Receive_Mode();
153 
154  //----------------------------------------------------------------------------
155  // Protected defines, methods and variables
156  //----------------------------------------------------------------------------
157 
158  protected:
159 
160 
161  //----------------------------------------------------------------------------
162  // Private methods, variables and definitions
163  //----------------------------------------------------------------------------
164 
165  private:
166 
167  //--------------------------------------------------------------------------
168  // Private type definitions
169  //--------------------------------------------------------------------------
170 
171 };
172 
173 //------------------------------------------------------------------------------
174 // End Of File
175 //------------------------------------------------------------------------------
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
STM32F429 on-chip UART6 module class header file.
STM32F429 on-chip UART6 hardware abstraction layer class for P015_09_CB.
Definition: UART6_P015_09_CB.h:98
virtual VOID PIO_Init()
PIO initialisation method.
Definition: UART6_P015_09_CB.cpp:113
virtual VOID PIO_Done()
PIO reinitialization as GPIO method.
Definition: UART6_P015_09_CB.cpp:157
virtual VOID Set_Receive_Mode()
Set receive mode method.
Definition: UART6_P015_09_CB.cpp:209
virtual VOID Set_Transmit_Mode()
Set transmit mode method.
Definition: UART6_P015_09_CB.cpp:197
STM32F429 on-chip UART6 hardware abstraction layer class.
Definition: UART6_STM32F429.h:62