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