ConOpSys V2970  P004.07
ANVILEX control operating system
UART1_P016_05_PUC2.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file UART1_P016_05_PUC2.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/P016_05_PUC2/UART1_P016_05_PUC2.h $
7 //! $Revision: 2203 $
8 //! $Date: 2020-11-21 14:58:09 +0500 (Sa, 21 Nov 2020) $
9 //! $Author: minch $
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 "UART1_STM32F410CBU6.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 #define UART1_TX_BUFFER_SIZE 256
70 
71 //------------------------------------------------------------------------------
72 // Define command strings
73 //------------------------------------------------------------------------------
74 
75 //------------------------------------------------------------------------------
76 // Struct
77 //------------------------------------------------------------------------------
78 
79 //------------------------------------------------------------------------------
80 // Externe variables
81 //------------------------------------------------------------------------------
82 
83 //------------------------------------------------------------------------------
84 // Function prototypes
85 //------------------------------------------------------------------------------
86 
87 //------------------------------------------------------------------------------
88 // Export variables
89 //------------------------------------------------------------------------------
90 
91 //------------------------------------------------------------------------------
92 // Class declarations
93 //------------------------------------------------------------------------------
94 
95 //! @brief STM32F410CBU6 on-chip UART1 hardware abstraction layer class for P016_05_PUC2.
97 {
98 
99  //----------------------------------------------------------------------------
100  // Public defines, methods and variables
101  //----------------------------------------------------------------------------
102 
103  public:
104 
105  //--------------------------------------------------------------------------
106  // Public methods
107  //--------------------------------------------------------------------------
108 
109  //!-------------------------------------------------------------------------
110  //! @brief PIO initialisation method
111  //! @note None
112  //! @return None
113  //! \par Override
114  //! Not allowed
115  //! @attention None
116  //--------------------------------------------------------------------------
117 
118  virtual VOID PIO_Init();
119 
120  //!-------------------------------------------------------------------------
121  //! @brief PIO deinitialisation methodmethod
122  //! @note This method initialised UART1 I/O poins as GPIO pins
123  //! @return None
124  //! \par Override
125  //! Not allowed
126  //! @attention None
127  //--------------------------------------------------------------------------
128 
129  virtual VOID PIO_Done();
130 /*
131  //!-------------------------------------------------------------------------
132  //! @brief Set transmit mode method.
133  //! @note None
134  //! @return None
135  //! \par Override
136  //! Not allowed
137  //! @attention None
138  //--------------------------------------------------------------------------
139 
140  virtual VOID Set_Transmit_Mode();
141 
142  //!-------------------------------------------------------------------------
143  //! @brief Set receive mode method.
144  //! @note None
145  //! @return None
146  //! \par Override
147  //! Not allowed
148  //! @attention None
149  //--------------------------------------------------------------------------
150 
151  virtual VOID Set_Receive_Mode();
152 */
153  //----------------------------------------------------------------------------
154  // Protected defines, methods and variables
155  //----------------------------------------------------------------------------
156 
157  protected:
158 
159 
160  //----------------------------------------------------------------------------
161  // Private methods, variables and definitions
162  //----------------------------------------------------------------------------
163 
164  private:
165 
166  //--------------------------------------------------------------------------
167  // Private type definitions
168  //--------------------------------------------------------------------------
169 
170 };
171 
172 //------------------------------------------------------------------------------
173 // End of file
174 //------------------------------------------------------------------------------
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
STM32F410CBU6 on-chip UART1 module class header file.
STM32F410CBU6 on-chip UART1 hardware abstraction layer class for P016_05_PUC2.
Definition: UART1_P016_05_PUC2.h:97
virtual VOID PIO_Init()
PIO initialisation method.
Definition: UART1_P016_05_PUC2.cpp:111
virtual VOID PIO_Done()
PIO deinitialisation methodmethod.
Definition: UART1_P016_05_PUC2.cpp:136
STM32F410CBU6 on-chip UART1 hardware abstraction layer class.
Definition: UART1_STM32F410CBU6.h:62