annotate Discovery/Inc/ostc_hw1.h @ 776:45b8f3c2acce

Add support for a configurable compass declination in a range of -99 to 99 degrees. This allows the displayed compass reading to be configured to take into account the compass declination (difference between the measured magnetic North direction and the actual geographical North direction) that has different values for different locations around the globe. See https://magnetic-declination.com/ for more information. (mikeller)
author heinrichsweikamp
date Thu, 18 May 2023 09:49:17 +0200
parents 5f11787b4f42
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
1 ///////////////////////////////////////////////////////////////////////////////
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
2 /// -*- coding: UTF-8 -*-
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
3 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
4 /// \file Discovery/Inc/ostc_hw1.h
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
5 /// \brief
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
6 /// \author Heinrichs Weikamp
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
7 /// \date 2018
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
8 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
9 /// $Id$
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
10 ///////////////////////////////////////////////////////////////////////////////
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
11 /// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
12 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
13 /// This program is free software: you can redistribute it and/or modify
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
14 /// it under the terms of the GNU General Public License as published by
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
15 /// the Free Software Foundation, either version 3 of the License, or
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
16 /// (at your option) any later version.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
17 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
18 /// This program is distributed in the hope that it will be useful,
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
19 /// but WITHOUT ANY WARRANTY; without even the implied warranty of
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
20 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
21 /// GNU General Public License for more details.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
22 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
23 /// You should have received a copy of the GNU General Public License
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
24 /// along with this program. If not, see <http://www.gnu.org/licenses/>.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
25 //////////////////////////////////////////////////////////////////////////////
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
26
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
27 /* Define to prevent recursive inclusion -------------------------------------*/
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
28 #ifndef OSTC_HW1_H
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
29 #define OSTC_HW1_H
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
30
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
31 /*
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
32 #define DISPLAY_BACKLIGHT_PIN GPIO_PIN_7
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
33 #define DISPLAY_BACKLIGHT_GPIO_PORT GPIOC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
34 #define DISPLAY_BACKLIGHT_GPIO_ENABLE() __GPIOC_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
35 */
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
36
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
37 #define DISPLAY_RESETB_PIN GPIO_PIN_13
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
38 #define DISPLAY_RESETB_GPIO_PORT GPIOC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
39 #define DISPLAY_RESETB_GPIO_ENABLE() __GPIOC_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
40
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
41 #define DISPLAY_CSB_PIN GPIO_PIN_8
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
42 #define DISPLAY_CSB_GPIO_PORT GPIOI
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
43 #define DISPLAY_CSB_GPIO_ENABLE() __GPIOI_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
44
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
45 #define VSYNC_IRQ_PIN GPIO_PIN_3
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
46 #define VSYNC_IRQ_GPIO_PORT GPIOE
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
47 #define VSYNC_IRQ_GPIO_ENABLE() __GPIOE_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
48 #define VSYNC_IRQ_EXTI_IRQn EXTI3_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
49
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
50 #define BUTTON_ENTER_PIN GPIO_PIN_4
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
51 #define BUTTON_ENTER_GPIO_PORT GPIOH
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
52 #define BUTTON_ENTER_GPIO_ENABLE() __GPIOH_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
53 #define BUTTON_ENTER_EXTI_IRQn EXTI4_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
54
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
55 #define BUTTON_DOWN_PIN GPIO_PIN_1
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
56 #define BUTTON_DOWN_GPIO_PORT GPIOA
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
57 #define BUTTON_DOWN_GPIO_ENABLE() __GPIOA_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
58 #define BUTTON_DOWN_EXTI_IRQn EXTI1_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
59
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
60 #define BUTTON_NEXT_PIN GPIO_PIN_2
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
61 #define BUTTON_NEXT_GPIO_PORT GPIOA
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
62 #define BUTTON_NEXT_GPIO_ENABLE() __GPIOA_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
63 #define BUTTON_NEXT_EXTI_IRQn EXTI2_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
64
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
65 #define BUTTON_BACK_PIN GPIO_PIN_0
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
66 #define BUTTON_BACK_GPIO_PORT GPIOB
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
67 #define BUTTON_BACK_GPIO_ENABLE() __GPIOB_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
68 #define BUTTON_BACK_EXTI_IRQn EXTI0_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
69
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
70 #define EXTFLASH_CSB_PIN GPIO_PIN_6
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
71 #define EXTFLASH_CSB_GPIO_PORT GPIOF
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
72 #define EXTFLASH_CSB_GPIO_ENABLE() __GPIOF_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
73
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
74 #define OSCILLOSCOPE_PIN GPIO_PIN_3
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
75 #define OSCILLOSCOPE_GPIO_PORT GPIOA
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
76 #define OSCILLOSCOPE_GPIO_ENABLE() __GPIOA_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
77
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
78 #define OSCILLOSCOPE2_PIN GPIO_PIN_11
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
79 #define OSCILLOSCOPE2_GPIO_PORT GPIOB
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
80 #define OSCILLOSCOPE2_GPIO_ENABLE() __GPIOB_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
81
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
82 #define IR_HUD_ENABLE_PIN GPIO_PIN_7
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
83 #define IR_HUD_ENABLE_GPIO_PORT GPIOD
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
84 #define IR_HUD_ENABLE_GPIO_ENABLE() __GPIOD_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
85
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
86 #define USARTx USART1
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
87 #define USARTx_CLK_ENABLE() __USART1_CLK_ENABLE();
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
88 #define USARTx_FORCE_RESET() __USART1_FORCE_RESET()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
89 #define USARTx_RELEASE_RESET() __USART1_RELEASE_RESET()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
90
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
91 #define USARTx_RX_AF GPIO_AF7_USART1
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
92 #define USARTx_RX_PIN GPIO_PIN_10
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
93 #define USARTx_RX_GPIO_PORT GPIOA
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
94 #define USARTx_RX_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
95
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
96 #define USARTx_TX_AF GPIO_AF7_USART1
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
97 #define USARTx_TX_PIN GPIO_PIN_9
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
98 #define USARTx_TX_GPIO_PORT GPIOA
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
99 #define USARTx_TX_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
100 #define USARTx_IRQn USART1_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
101 #define USARTx_IRQHandler USART1_IRQHandler
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
102
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
103 #define USART_PIEZO USART3
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
104 #define USART_PIEZO_TX_AF GPIO_AF7_USART3
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
105 #define USART_PIEZO_TX_PIN GPIO_PIN_10
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
106 #define USART_PIEZO_TX_GPIO_PORT GPIOC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
107 #define USART_PIEZO_TX_GPIO_CLK_ENABLE() __GPIOC_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
108
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
109 #define USART_PIEZO_RX_AF GPIO_AF7_USART3
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
110 #define USART_PIEZO_RX_PIN GPIO_PIN_11
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
111 #define USART_PIEZO_RX_GPIO_PORT GPIOC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
112 #define USART_PIEZO_RX_GPIO_CLK_ENABLE() __GPIOC_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
113
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
114 #define USART_IR_HUD USART2
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
115 #define USART_IR_HUD_CLK_ENABLE() __USART2_CLK_ENABLE();
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
116 #define USART_IR_HUD_FORCE_RESET() __USART2_FORCE_RESET()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
117 #define USART_IR_HUD_RELEASE_RESET() __USART2_RELEASE_RESET()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
118 #define USART_IR_HUD_TX_AF GPIO_AF7_USART2
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
119 #define USART_IR_HUD_TX_PIN GPIO_PIN_5
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
120 #define USART_IR_HUD_TX_GPIO_PORT GPIOD
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
121 #define USART_IR_HUD_TX_GPIO_CLK_ENABLE() __GPIOD_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
122
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
123 #define USART_IR_HUD_RX_AF GPIO_AF7_USART2
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
124 #define USART_IR_HUD_RX_PIN GPIO_PIN_6
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
125 #define USART_IR_HUD_RX_GPIO_PORT GPIOD
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
126 #define USART_IR_HUD_RX_GPIO_CLK_ENABLE() __GPIOD_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
127 #define USART_IR_HUD_IRQn USART2_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
128 #define USART_IR_HUD_IRQHandler USART2_IRQHandler
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
129
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
130 #define TIMx TIM4
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
131 #define TIMx_CLK_ENABLE __TIM4_CLK_ENABLE
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
132 #define TIMx_IRQn TIM4_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
133 #define TIMx_IRQHandler TIM4_IRQHandler
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
134
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
135 #define TIM_BACKLIGHT TIM3
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
136 #define TIM_BACKLIGHT_CLK_ENABLE __TIM3_CLK_ENABLE
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
137 #define TIM_BACKLIGHT_IRQn TIM3_IRQn
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
138 #define TIM_BACKLIGHT_IRQHandler TIM3_IRQHandler
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
139 #define TIM_BACKLIGHT_CHANNEL TIM_CHANNEL_2
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
140 #define TIM_BACKLIGHT_PIN GPIO_PIN_7
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
141 #define TIM_BACKLIGHT_GPIO_PORT GPIOC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
142 #define TIM_BACKLIGHT_GPIO_ENABLE() __GPIOC_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
143
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
144 #define SMALLCPU_CSB_PIN GPIO_PIN_5
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
145 #define SMALLCPU_CSB_GPIO_PORT GPIOC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
146 #define SMALLCPU_CSB_GPIO_ENABLE() __GPIOC_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
147
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
148 #define SMALLCPU_BOOT0_PIN GPIO_PIN_9
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
149 #define SMALLCPU_BOOT0_GPIO_PORT GPIOC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
150 #define SMALLCPU_BOOT0_GPIO_ENABLE() __GPIOC_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
151
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
152 #define SMALLCPU_NRESET_PIN GPIO_PIN_8
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
153 #define SMALLCPU_NRESET_GPIO_PORT GPIOC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
154 #define SMALLCPU_NRESET_GPIO_ENABLE() __GPIOC_CLK_ENABLE()
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
155
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
156 #endif OSTC_HW1_H