ConOpSys V2970  P004.07
ANVILEX control operating system
SPI4_P017_39_KG3_CB.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file SPI4_P017_39_KG3_CB.h
3 //! @brief STM32F429 SPI4 master class header file.
4 //! @copyright ANVILEX LLC
5 //! @attention No special attention requered.
6 //! $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P017_39_KG3_CB/SPI4_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) 2015-2020 ANVILEX LLC
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 // Include project files
45 //------------------------------------------------------------------------------
46 
47 #include "SPI4_STM32F429.h"
48 
49 //------------------------------------------------------------------------------
50 
51 //! @brief On chip SPI4 bus master unit class
53 {
54 
55  //----------------------------------------------------------------------------
56  // Public defines, methods and variables
57  //----------------------------------------------------------------------------
58 
59  public:
60 
61  //!-------------------------------------------------------------------------
62  //! @brief Class constructor method
63  //! @note None
64  //! \par Override
65  //! Not allowed
66  //! @attention Don't call this method directly.
67  //--------------------------------------------------------------------------
68 
70 
71  //!-------------------------------------------------------------------------
72  //! @brief Class destructor method
73  //! @note None
74  //! \par Override
75  //! Not allowed
76  //! @attention Don't call this method directly.
77  //--------------------------------------------------------------------------
78 
79  virtual ~TSPI4_P017_39_KG3_CB();
80 
81  //!-------------------------------------------------------------------------
82  //! @brief PIO initialisation method
83  //! @note None
84  //! @return None
85  //! \par Override
86  //! Not allowed
87  //! @attention None
88  //--------------------------------------------------------------------------
89 
90  virtual VOID PIO_Init();
91 
92  //!-------------------------------------------------------------------------
93  //! @brief PIO reinitialisation as GPIO method
94  //! @note None
95  //! @return None
96  //! \par Override
97  //! Not allowed
98  //! @attention None
99  //--------------------------------------------------------------------------
100 
101  virtual VOID PIO_Done();
102 
103  //!-------------------------------------------------------------------------
104  //! @brief Activate (set to 0) SPI bus chip select signal
105  //! @note None
106  //! @return None
107  //! \par Override
108  //! Not allowed
109  //! @attention None
110  //--------------------------------------------------------------------------
111 
112  virtual VOID CS_Activate();
113 
114  //!-------------------------------------------------------------------------
115  //! @brief Deactivate (set to 1) SPI bus chip select signal
116  //! @note None
117  //! @return None
118  //! \par Override
119  //! Not allowed
120  //! @attention None
121  //--------------------------------------------------------------------------
122 
123  virtual VOID CS_Deactivate();
124 
125  //----------------------------------------------------------------------------
126  // Protected defines, methods and variables
127  //----------------------------------------------------------------------------
128 
129  protected:
130 
131  //----------------------------------------------------------------------------
132  // Private defines, methods and variables
133  //----------------------------------------------------------------------------
134 
135  private:
136 
137 };
138 
139 //------------------------------------------------------------------------------
140 // End Of File
141 //------------------------------------------------------------------------------
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
STM32F429 on-chip SPI4 bus master module class header file.
On chip SPI4 bus master unit class.
Definition: SPI4_P017_39_KG3_CB.h:53
virtual VOID CS_Deactivate()
Deactivate (set to 1) SPI bus chip select signal.
Definition: SPI4_P017_39_KG3_CB.cpp:172
virtual VOID CS_Activate()
Activate (set to 0) SPI bus chip select signal.
Definition: SPI4_P017_39_KG3_CB.cpp:155
TSPI4_P017_39_KG3_CB()
Class constructor method.
Definition: SPI4_P017_39_KG3_CB.cpp:71
virtual ~TSPI4_P017_39_KG3_CB()
Class destructor method.
Definition: SPI4_P017_39_KG3_CB.cpp:79
virtual VOID PIO_Done()
PIO reinitialisation as GPIO method.
Definition: SPI4_P017_39_KG3_CB.cpp:127
virtual VOID PIO_Init()
PIO initialisation method.
Definition: SPI4_P017_39_KG3_CB.cpp:87
STM32F429 on-chip SPI4 bus master module class.
Definition: SPI4_STM32F429.h:54