Stepper-Motor-Control  v3.0.0
System on a Chip 2014 - Group 04
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
userInputTask.h
Go to the documentation of this file.
1 /**
2  *****************************************************************************
3  * @file userInputTask.h
4  * @author Michael Riedel
5  * @author Marc Kossmann
6  * @version v2.0.0
7  * @date 18.11.2014
8  * @brief Header file for userInputTask.c
9  * @details Contains defines, includes, typedefs and declarations needed
10  * for this task.
11  *****************************************************************************
12  * @par History:
13  * @details v0.1.0 22.10.2014 Riedel & Kossmann
14  * - first draft for milestone 1b
15  * @details v0.1.1 27.10.2014 Riedel
16  * - moved events to events.h for better handling
17  * @details v0.1.2 30.10.2014 Kossmann
18  * - removed hardwareAccess.h include
19  * @details v0.1.3 30.10.2014 Kossmann
20  * - added debug and error handling header
21  * @details v0.1.4 30.10.2014 Riedel
22  * - cleaned includes
23  * @details v0.1.5 31.10.2014 Riedel & Kossmann
24  * - added hardwareTest() declaration
25  * @details v1.0.0 03.11.2014 Kossmann
26  * - moved all register masks in registerAccess.h
27  * @details v1.0.1 13.11.2014 Kossmann
28  * - moved all own data types to dataTypes.h
29  * @details v1.0.2 14.11.2014 Riedel & Kossmann
30  * - added define for register mutex (see registerAccess.h)
31  * @details v2.0.0 18.11.2014 Riedel & Kossmann
32  * - removed define for register mutex for real register_interface
33  * - verified functionality -> release MS2
34  *****************************************************************************
35  */
36 
37 #ifndef __USER_INPUT_TASK_H__
38 #define __USER_INPUT_TASK_H__
39 
40 #include <sys/alt_irq.h>
41 #include <stdio.h>
42 #include <stdint.h>
43 #include <stdbool.h>
44 #include <math.h>
45 
46 #include "includes.h"
47 #include "events.h"
48 #include "hardwareAccess.h"
49 #include "registerAccess.h"
50 #include "dataTypes.h"
51 
52 #include "auxilaryFunctions.h"
53 #include "debugAndErrorOutput.h"
54 
55 #define INTERRUPT_ENABLE //!< global interrupts are enabled
56 
57 #define CTRL_REG_0_6_MSK (0b01111111) //!< Bits 0..6 in ctrlReg
58 
59 /**
60  * @brief UserInputTask
61  * @details This task is the control instance for the whole system.
62  * All register access is done in this Task. It reacts to user input,
63  * sets needed flags and delivers needed informatino to other tasks.
64  * @param pdata : Pointer to parameter structure (not used)
65  * @retval None
66  */
67 void UserInputTask(void *pdata);
68 
69 /**
70  * @brief Tests hardware
71  * @details A functions for just test some hardware features. Has no needed
72  * functionality for any Milestone
73  * @retval None
74  */
75 void hardwareTest(void);
76 
77 #endif // __USER_INPUT_TASK_H__
auxilaryFunctions.h
Header file for auxilaryFunctions.c.
hardwareAccess.h
Functions for accessing hardware connected through pio´s and registers.
UserInputTask
void UserInputTask(void *pdata)
UserInputTask.
Definition: userInputTask.c:55
events.h
definitions for used events
hardwareTest
void hardwareTest(void)
Tests hardware.
Definition: userInputTask.c:223
registerAccess.h
Header file with inline functions to access the registers that are used by the Stepper-Motor-Control ...
dataTypes.h
Header file for all own data types.
debugAndErrorOutput.h
Defines for Error and Debug-Output Management.