ch.fhnw.eit.bldcDriver.API/platformAPI.h at master · sdbuehlmann/ch.fhnw.eit.bldcDriver.API · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 * plattformAPI.h
 *
 *  Created on: Nov 29, 2017
 *      Author: simon
 */

#ifndef INC_PLATFORMAPI_H_
#define INC_PLATFORMAPI_H_

#include <stdint.h>

#include "platformAPIConfig.h"
// =============== defines ====================================================================================================
#define PLATFORM_ERROR platformError(__FILE__, __LINE__)

// =============== type definitions ===========================================================================================
typedef enum {
	phase_A, phase_B, phase_C

} Phase;

typedef enum {
	bridgeside_highside, bridgeside_lowside
} Bridgeside;

typedef enum {
	false = 0, true = 1
} Boolean;

typedef enum {
	edge_rising, edge_falling
} Edge;

typedef enum {
	adcStatus_running, adcStatus_started, adcStatus_error
} ADCStatus;

typedef enum {
	uartStatus_ok, uartStatus_tooMouchData
} UARTStatus;


typedef enum {
	controlSignalType_negative_torque, controlSignalType_positive_torque
} ControlSignalType;

typedef void (*StartDelayedCallback)(uint32_t timeToCall_us);
typedef void (*DelayedCallback)(void);

typedef enum {
	delayedCallbackStatus_ready, delayedCallbackStatus_running
} DelayedCallbackStatus;

typedef struct {
	DelayedCallback callback;
	StartDelayedCallback start;
	DelayedCallbackStatus status;
	uint32_t timestampRegistered_us;
	uint32_t timeUntilCallback_us;
} DelayedCallbackHandle;

typedef enum {
	delayedCallbackFeedback_registered, delayedCallbackFeedback_error
} DelayedCallbackFeedback;

// =============== functions ==================================================================================================
// ***to be implemented******************************************************
void startup();
void proceed();
// **************************************************************************

// --------------- serializing ------------------------------------------------------------------------------------------------
void entryNoIRQSection();
void leaveNoIRQSection();

// --------------- pwm --------------------------------------------------------------------------------------------------------
#ifdef PWM
void setPWMDutyCycle(uint8_t dutyCycle);

void enablePWM(Phase phase, Bridgeside side);
void disablePWM(Phase phase, Bridgeside side);
#endif /* PWM */

// --------------- adc --------------------------------------------------------------------------------------------------------
#ifdef ADC
// ***to be implemented******************************************************
void newData_currentPhaseA(int32_t current_mA, uint32_t range_mA);
void newData_currentPhaseB(int32_t current_mA, uint32_t range_mA);

void newData_controlSignal(uint32_t controlSignal);
void newData_mainVoltage(uint32_t mainVoltage);
void newData_calibrateEncoder(uint32_t calibrateEncoder);
// **************************************************************************

ADCStatus startMeasCurrentPhaseA();
ADCStatus startMeasCurrentPhaseB();

ADCStatus startMeasControlSignal();
ADCStatus startMeasMainVoltage();
ADCStatus startMeasEncoderCalibration();
#endif /* ADC */

// --------------- comperators ------------------------------------------------------------------------------------------------
#ifdef COMPERATORS
// ***to be implemented******************************************************
void event_comperatorSignalChanged(Phase phase, Edge edge);
// **************************************************************************

void enableComperator(Phase phase, Edge edge, Boolean enable);
Boolean isComperatorSignalHigh(Phase phase);
#endif /* COMPERATORS */

// --------------- gpio's -----------------------------------------------------------------------------------------------------
Boolean isBoardEnabled();
Boolean isNFaultFromBridgeDriver();
Boolean isNOCTWFromBridgeDriver();
Boolean isPWRGDFromBridgeDriver();
Boolean isEncoderEnabled();
Boolean isCalibrateEncoder();

ControlSignalType getControlSignalType();

void setLED(Boolean ledON);
void setEnableBridgeDriver(Boolean enable);
void setDCCalBridgeDriver(Boolean dcCal);

// --------------- systime ----------------------------------------------------------------------------------------------------
#ifdef SYSTIME
uint32_t getSystimeUs();
DelayedCallbackFeedback startDelayedCallback(uint32_t timeUntilCallback_us, DelayedCallback callback);

void wait_ms(uint32_t ms);
#endif /* SYSTIME */

// --------------- uart ------------------------------------------------------------------------------------------------------
#ifdef UART
// ***to be implemented******************************************************
void event_uartDataReceived(uint8_t *pData, uint8_t nrData);
// **************************************************************************

UARTStatus sendUartData(uint8_t *pData, uint8_t size);
#endif /* UART */

// --------------- encoder ----------------------------------------------------------------------------------------------------
#ifdef ENCODER
// ***to be implemented******************************************************
void event_rotaded180Degrees();
void newData_encoderCalibration(uint32_t encoderCal);
// **************************************************************************

void enableEncoder(Boolean enable);
uint32_t getRotadedDegreesEncoder();
void setRotadedDegreesEncoder(uint32_t rotadedDeg);
void resetRotadedDegreesEncoder();

Boolean isEncoderSignalA();
Boolean isEncoderSignalB();

void setEncoderCalibrationReferencePosition(Boolean state);
#endif /* ENCODER */

// --------------- error ----------------------------------------------------------------------------------------------------
// to be implemented:
void platformError(char file[], uint32_t line);
//--------------------

#endif /* PLATTFORMAPI_H_ */