AVRly - AVR Development Resources
main.c
Go to the documentation of this file.
1/******************************************************************************
2 @copyright Copyright © 2022 by Your Name Here.
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21******************************************************************************/
22
23/**
24 * @file main.c
25 * @ingroup anatomy
26 * @author Your Name Here
27 * @date 15th March 2022
28 * @brief Main source file where main() routine is called.
29 * @bug Known bugs are declared and described here.
30 * @see links to other files or docs go here.
31 */
32
33// Include our driver header file here.
34#include "filename.h"
35
36/**
37 * Avoid using magic bumbers, use defines or typedef enums instead.
38 */
39#define INITIALISATION_VALUE 3000
40
41uint16_t returned_value = 0;
42
43/**
44 * Main routine to be executed on MCU.
45 */
46int main()
47{
48 // Initialisation routines go here.
49 init_object(INITIALISATION_VALUE);
50
51 while (1) // Loop forever
52 {
53 returned_value = get_value();
54 }
55
56 return 0; // This line is never reached.
57}
58
59
60/*** end of file ***/
INITIALISATION_VALUE
#define INITIALISATION_VALUE
Avoid using magic bumbers, use defines or typedef enums instead.
Definition: main.c:39
get_value
uint16_t get_value(void)
Other public function declarations come afterwards.
Definition: filename.c:87
init_object
void init_object(uint16_t value)
This is a Javadoc autobrief style comment.
Definition: filename.c:74
filename.h
The brief description goes here, keep it relatively short and to the point.
main
int main()
Main routine to be executed on the MCU.
Definition: main.c:45