Types and macros for error handling. More...

#include <string.h>

Include dependency graph for ErrorTypes.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	errorInfo_s
	Structure used for saving error information. More...

Macros
#define	OS_CALL_ERROR_HOOK(error)
	Call error hook if configured. More...

#define	OS_SET_ERROR_INFO0(serviceId)
	Set error info with zero parameters. More...

#define	OS_SET_ERROR_INFO1(serviceId, paramPtr1, size1)
	Set error info with up to one parameter. More...

#define	OS_SET_ERROR_INFO2(serviceId, paramPtr1, size1, paramPtr2, size2)
	Set error info with up to two parameters. More...

#define	OS_SET_ERROR_INFO3(serviceId, paramPtr1, size1, paramPtr2, size2, paramPtr3, size3)
	Set error info with up to three parameters. More...

#define	OSErrorGetServiceId() (errorInfo.id);

#define	OSError_GetAlarmBase_AlarmID() ((AlarmType) errorInfo.param1)

#define	OSError_GetAlarmBase_Info() ((AlarmBaseRefType) errorInfo.param2)

#define	OSError_GetAlarm_AlarmID() ((AlarmType) errorInfo.param1)

#define	OSError_GetAlarm_Tick() ((TickRefType) errorInfo.param2)

#define	OSError_SetRelAlarm_AlarmID() ((AlarmType) errorInfo.param1)

#define	OSError_SetRelAlarm_increment() ((TickType) errorInfo.param2)

#define	OSError_SetRelAlarm_cycle() ((TickType) errorInfo.param3)

#define	OSError_SetAbsAlarm_AlarmID() ((AlarmType) errorInfo.param1)

#define	OSError_SetAbsAlarm_start() ((TickType) errorInfo.param2)

#define	OSError_SetAbsAlarm_cycle() ((TickType) errorInfo.param3)

#define	OSError_CancelAlarm_AlarmID() ((AlarmType) errorInfo.param1)

#define	OSError_IncrementCounter_CounterID() ((CounterType) errorInfo.param1)

#define	OSError_GetCounterValue_CounterID() ((CounterType) errorInfo.param1)

#define	OSError_GetCounterValue_Value() ((TickRefType) errorInfo.param2)

#define	OSError_GetElapsedValue_CounterID() ((CounterType) errorInfo.param1)

#define	OSError_GetElapsedValue_Value() ((TickRefType) errorInfo.param2)

#define	OSError_GetElapsedValue_ElapsedValue() ((TickRefType) errorInfo.param3)

#define	OSError_SetEvent_TaskID() ((TaskType) errorInfo.param1)

#define	OSError_SetEvent_Mask() ((EventMaskType) errorInfo.param2)

#define	OSError_ClearEvent_Mask() ((EventMaskType) errorInfo.param1)

#define	OSError_GetEvent_TaskID() ((TaskType) errorInfo.param1)

#define	OSError_GetEvent_Type() ((EventMaskRefType) errorInfo.param2)

#define	OSError_WaitEvent_Mask() ((EventMaskType) errorInfo.param1)

#define	OSError_StartOS_Mode() ((AppModeType) errorInfo.param1)

#define	OSError_ShutdownOS_Error ((StatusType) errorInfo.param1)

#define	OSError_GetResource_ResID() ((ResourceType) errorInfo.param1)

#define	OSError_ReleaseResource_ResID() ((ResourceType) errorInfo.param1)

#define	OSError_ActivateTask_TaskID() ((TaskType) errorInfo.param1)

#define	OSError_ChainTask_TaskID() ((TaskType) errorInfo.param1)

#define	OSError_GetTaskID_TaskID() ((TaskRefType) errorInfo.param1)

#define	OSError_GetTaskState_TaskID() ((TaskType) errorInfo.param1)

#define	OSError_GetTaskState_State() ((TaskStateRefType) errorInfo.param2)

#define	OSError_StartScheduleTableRel_ScheduleTableID ((ScheduleTableType) errorInfo.param1)

#define	OSError_StartScheduleTableRel_Offset ((TickType) errorInfo.param2)

#define	OSError_StartScheduleTableAbs_ScheduleTableID ((ScheduleTableType) errorInfo.param1)

#define	OSError_StartScheduleTableAbs_Start ((TickType) errorInfo.param2)

#define	OSError_StopScheduleTable_ScheduleTableID ((ScheduleTableType) errorInfo.param1)

#define	OSError_NextScheduleTable_ScheduleTableID_From ((ScheduleTableType) errorInfo.param1)

#define	OSError_NextScheduleTable_ScheduleTableID_To ((ScheduleTableType) errorInfo.param2)

#define	OSError_GetScheduleTableStatus_ScheduleTableID ((ScheduleTableType) errorInfo.param1)

#define	OSError_GetScheduleTableStatus_ScheduleStatus ((ScheduleTableStatusRefType) errorInfo.param2)

Typedefs
typedef enum osServiceIdType	OSServiceIdType
	Type for Service IDs. More...

Enumerations
enum	osServiceIdType { OSServiceId_GetAlarmBase = 0, OSServiceId_GetAlarm, OSServiceId_SetRelAlarm, OSServiceId_SetAbsAlarm, OSServiceId_CancelAlarm, OSServiceId_IncrementCounter, OSServiceId_GetCounterValue, OSServiceId_GetElapsedValue, OSServiceId_SetEvent, OSServiceId_ClearEvent, OSServiceId_GetEvent, OSServiceId_WaitEvent, OSServiceId_StartOS, OSServiceId_ShutdownOS, OSServiceId_GetActiveApplicationMode, OSServiceId_EnableAllInterrupts, OSServiceId_DisableAllInterrupts, OSServiceId_ResumeAllInterrupts, OSServiceId_SuspendAllInterrupts, OSServiceId_ResumeOSInterrupts, OSServiceId_SuspendOSInterrupts, OSServiceId_GetResource, OSServiceId_ReleaseResource, OSServiceId_ActivateTask, OSServiceId_ChainTask, OSServiceId_TerminateTask, OSServiceId_Schedule, OSServiceId_GetTaskID, OSServiceId_GetTaskState, OSServiceId_StartScheduleTableRel, OSServiceId_StartScheduleTableAbs, OSServiceId_StopScheduleTable, OSServiceId_NextScheduleTable, OSServiceId_GetScheduleTableStatus }
	Type for Service IDs. More...

Detailed Description

Types and macros for error handling.

Date: 2020-06-18

Author: Pascal Romahn

Copyright: This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Definition in file ErrorTypes.h.

Macro Definition Documentation

◆ OS_CALL_ERROR_HOOK

#define OS_CALL_ERROR_HOOK ( error )

Call error hook if configured.

Call the ErrorHook() if it is configured. Also block recursive calls of the hook and disable interrupts if necessary.

Parameters

error StatusType passed to the ErrorHook()

Definition at line 93 of file ErrorTypes.h.

◆ OS_SET_ERROR_INFO0

#define OS_SET_ERROR_INFO0 ( serviceId )

Set error info with zero parameters.

This will set error info with service ID if OS_CONFIG_MAX_ERROR_PARAM is set to at least zero.

Parameters

serviceId ID of the service

Definition at line 208 of file ErrorTypes.h.

◆ OS_SET_ERROR_INFO1

#define OS_SET_ERROR_INFO1	(	serviceId,
		paramPtr1,
		size1
	)

Set error info with up to one parameter.

This will set error info with service ID and up to one parameter if OS_CONFIG_MAX_ERROR_PARAM is set to at least zero.

Parameters

serviceId	ID of the service
paramPtr1	Pointer to first parameter (used if OS_CONFIG_MAX_ERROR_PARAM >= 1)
size1	Size of first parameter in bytes (used if OS_CONFIG_MAX_ERROR_PARAM >= 1)

Definition at line 220 of file ErrorTypes.h.

◆ OS_SET_ERROR_INFO2

#define OS_SET_ERROR_INFO2	(	serviceId,
		paramPtr1,
		size1,
		paramPtr2,
		size2
	)

Set error info with up to two parameters.

This will set error info with service ID and up to two parameters if OS_CONFIG_MAX_ERROR_PARAM is set to at least zero.

Parameters

serviceId	ID of the service
paramPtr1	Pointer to first parameter (used if OS_CONFIG_MAX_ERROR_PARAM >= 1)
size1	Size of first parameter in bytes (used if OS_CONFIG_MAX_ERROR_PARAM >= 1)
paramPtr2	Pointer to first parameter (used if OS_CONFIG_MAX_ERROR_PARAM >= 2)
size2	Size of first parameter in bytes (used if OS_CONFIG_MAX_ERROR_PARAM >= 2)

Definition at line 234 of file ErrorTypes.h.

◆ OS_SET_ERROR_INFO3

#define OS_SET_ERROR_INFO3	(	serviceId,
		paramPtr1,
		size1,
		paramPtr2,
		size2,
		paramPtr3,
		size3
	)

Set error info with up to three parameters.

This will set error info with service ID and up to three parameters if OS_CONFIG_MAX_ERROR_PARAM is set to at least zero.

Parameters

serviceId	ID of the service
paramPtr1	Pointer to first parameter (used if OS_CONFIG_MAX_ERROR_PARAM >= 1)
size1	Size of first parameter in bytes (used if OS_CONFIG_MAX_ERROR_PARAM >= 1)
paramPtr2	Pointer to first parameter (used if OS_CONFIG_MAX_ERROR_PARAM >= 2)
size2	Size of first parameter in bytes (used if OS_CONFIG_MAX_ERROR_PARAM >= 2)
paramPtr3	Pointer to first parameter (used if OS_CONFIG_MAX_ERROR_PARAM >= 3)
size3	Size of first parameter in bytes (used if OS_CONFIG_MAX_ERROR_PARAM >= 3)

Definition at line 250 of file ErrorTypes.h.

◆ OSError_ActivateTask_TaskID

#define OSError_ActivateTask_TaskID ( ) ((TaskType) errorInfo.param1)

Definition at line 318 of file ErrorTypes.h.

◆ OSError_CancelAlarm_AlarmID

#define OSError_CancelAlarm_AlarmID ( ) ((AlarmType) errorInfo.param1)

Definition at line 277 of file ErrorTypes.h.

◆ OSError_ChainTask_TaskID

#define OSError_ChainTask_TaskID ( ) ((TaskType) errorInfo.param1)

Definition at line 321 of file ErrorTypes.h.

◆ OSError_ClearEvent_Mask

#define OSError_ClearEvent_Mask ( ) ((EventMaskType) errorInfo.param1)

Definition at line 296 of file ErrorTypes.h.

◆ OSError_GetAlarm_AlarmID

#define OSError_GetAlarm_AlarmID ( ) ((AlarmType) errorInfo.param1)

Definition at line 263 of file ErrorTypes.h.

◆ OSError_GetAlarm_Tick

#define OSError_GetAlarm_Tick ( ) ((TickRefType) errorInfo.param2)

Definition at line 264 of file ErrorTypes.h.

◆ OSError_GetAlarmBase_AlarmID

#define OSError_GetAlarmBase_AlarmID ( ) ((AlarmType) errorInfo.param1)

Definition at line 259 of file ErrorTypes.h.

◆ OSError_GetAlarmBase_Info

#define OSError_GetAlarmBase_Info ( ) ((AlarmBaseRefType) errorInfo.param2)

Definition at line 260 of file ErrorTypes.h.

◆ OSError_GetCounterValue_CounterID

#define OSError_GetCounterValue_CounterID ( ) ((CounterType) errorInfo.param1)

Definition at line 283 of file ErrorTypes.h.

◆ OSError_GetCounterValue_Value

#define OSError_GetCounterValue_Value ( ) ((TickRefType) errorInfo.param2)

Definition at line 284 of file ErrorTypes.h.

◆ OSError_GetElapsedValue_CounterID

#define OSError_GetElapsedValue_CounterID ( ) ((CounterType) errorInfo.param1)

Definition at line 287 of file ErrorTypes.h.

◆ OSError_GetElapsedValue_ElapsedValue

#define OSError_GetElapsedValue_ElapsedValue ( ) ((TickRefType) errorInfo.param3)

Definition at line 289 of file ErrorTypes.h.

◆ OSError_GetElapsedValue_Value

#define OSError_GetElapsedValue_Value ( ) ((TickRefType) errorInfo.param2)

Definition at line 288 of file ErrorTypes.h.

◆ OSError_GetEvent_TaskID

#define OSError_GetEvent_TaskID ( ) ((TaskType) errorInfo.param1)

Definition at line 299 of file ErrorTypes.h.

◆ OSError_GetEvent_Type

#define OSError_GetEvent_Type ( ) ((EventMaskRefType) errorInfo.param2)

Definition at line 300 of file ErrorTypes.h.

◆ OSError_GetResource_ResID

#define OSError_GetResource_ResID ( ) ((ResourceType) errorInfo.param1)

Definition at line 312 of file ErrorTypes.h.

◆ OSError_GetScheduleTableStatus_ScheduleStatus

#define OSError_GetScheduleTableStatus_ScheduleStatus ((ScheduleTableStatusRefType) errorInfo.param2)

Definition at line 347 of file ErrorTypes.h.

◆ OSError_GetScheduleTableStatus_ScheduleTableID

#define OSError_GetScheduleTableStatus_ScheduleTableID ((ScheduleTableType) errorInfo.param1)

Definition at line 346 of file ErrorTypes.h.

◆ OSError_GetTaskID_TaskID

#define OSError_GetTaskID_TaskID ( ) ((TaskRefType) errorInfo.param1)

Definition at line 324 of file ErrorTypes.h.

◆ OSError_GetTaskState_State

#define OSError_GetTaskState_State ( ) ((TaskStateRefType) errorInfo.param2)

Definition at line 328 of file ErrorTypes.h.

◆ OSError_GetTaskState_TaskID

#define OSError_GetTaskState_TaskID ( ) ((TaskType) errorInfo.param1)

Definition at line 327 of file ErrorTypes.h.

◆ OSError_IncrementCounter_CounterID

#define OSError_IncrementCounter_CounterID ( ) ((CounterType) errorInfo.param1)

Definition at line 280 of file ErrorTypes.h.

◆ OSError_NextScheduleTable_ScheduleTableID_From

#define OSError_NextScheduleTable_ScheduleTableID_From ((ScheduleTableType) errorInfo.param1)

Definition at line 342 of file ErrorTypes.h.

◆ OSError_NextScheduleTable_ScheduleTableID_To

#define OSError_NextScheduleTable_ScheduleTableID_To ((ScheduleTableType) errorInfo.param2)

Definition at line 343 of file ErrorTypes.h.

◆ OSError_ReleaseResource_ResID

#define OSError_ReleaseResource_ResID ( ) ((ResourceType) errorInfo.param1)

Definition at line 315 of file ErrorTypes.h.

◆ OSError_SetAbsAlarm_AlarmID

#define OSError_SetAbsAlarm_AlarmID ( ) ((AlarmType) errorInfo.param1)

Definition at line 272 of file ErrorTypes.h.

◆ OSError_SetAbsAlarm_cycle

#define OSError_SetAbsAlarm_cycle ( ) ((TickType) errorInfo.param3)

Definition at line 274 of file ErrorTypes.h.

◆ OSError_SetAbsAlarm_start

#define OSError_SetAbsAlarm_start ( ) ((TickType) errorInfo.param2)

Definition at line 273 of file ErrorTypes.h.

◆ OSError_SetEvent_Mask

#define OSError_SetEvent_Mask ( ) ((EventMaskType) errorInfo.param2)

Definition at line 293 of file ErrorTypes.h.

◆ OSError_SetEvent_TaskID

#define OSError_SetEvent_TaskID ( ) ((TaskType) errorInfo.param1)

Definition at line 292 of file ErrorTypes.h.

◆ OSError_SetRelAlarm_AlarmID

#define OSError_SetRelAlarm_AlarmID ( ) ((AlarmType) errorInfo.param1)

Definition at line 267 of file ErrorTypes.h.

◆ OSError_SetRelAlarm_cycle

#define OSError_SetRelAlarm_cycle ( ) ((TickType) errorInfo.param3)

Definition at line 269 of file ErrorTypes.h.

◆ OSError_SetRelAlarm_increment

#define OSError_SetRelAlarm_increment ( ) ((TickType) errorInfo.param2)

Definition at line 268 of file ErrorTypes.h.

◆ OSError_ShutdownOS_Error

#define OSError_ShutdownOS_Error ((StatusType) errorInfo.param1)

Definition at line 309 of file ErrorTypes.h.

◆ OSError_StartOS_Mode

#define OSError_StartOS_Mode ( ) ((AppModeType) errorInfo.param1)

Definition at line 306 of file ErrorTypes.h.

◆ OSError_StartScheduleTableAbs_ScheduleTableID

#define OSError_StartScheduleTableAbs_ScheduleTableID ((ScheduleTableType) errorInfo.param1)

Definition at line 335 of file ErrorTypes.h.

◆ OSError_StartScheduleTableAbs_Start

#define OSError_StartScheduleTableAbs_Start ((TickType) errorInfo.param2)

Definition at line 336 of file ErrorTypes.h.

◆ OSError_StartScheduleTableRel_Offset

#define OSError_StartScheduleTableRel_Offset ((TickType) errorInfo.param2)

Definition at line 332 of file ErrorTypes.h.

◆ OSError_StartScheduleTableRel_ScheduleTableID

#define OSError_StartScheduleTableRel_ScheduleTableID ((ScheduleTableType) errorInfo.param1)

Definition at line 331 of file ErrorTypes.h.

◆ OSError_StopScheduleTable_ScheduleTableID

#define OSError_StopScheduleTable_ScheduleTableID ((ScheduleTableType) errorInfo.param1)

Definition at line 339 of file ErrorTypes.h.

◆ OSError_WaitEvent_Mask

#define OSError_WaitEvent_Mask ( ) ((EventMaskType) errorInfo.param1)

Definition at line 303 of file ErrorTypes.h.

◆ OSErrorGetServiceId

#define OSErrorGetServiceId ( ) (errorInfo.id);

Definition at line 256 of file ErrorTypes.h.

Typedef Documentation

◆ OSServiceIdType

typedef enum osServiceIdType OSServiceIdType

Type for Service IDs.

Enumeration Type Documentation

◆ osServiceIdType

enum osServiceIdType

Type for Service IDs.

Enumerator
OSServiceId_GetAlarmBase
OSServiceId_GetAlarm
OSServiceId_SetRelAlarm
OSServiceId_SetAbsAlarm
OSServiceId_CancelAlarm
OSServiceId_IncrementCounter
OSServiceId_GetCounterValue
OSServiceId_GetElapsedValue
OSServiceId_SetEvent
OSServiceId_ClearEvent
OSServiceId_GetEvent
OSServiceId_WaitEvent
OSServiceId_StartOS
OSServiceId_ShutdownOS
OSServiceId_GetActiveApplicationMode
OSServiceId_EnableAllInterrupts
OSServiceId_DisableAllInterrupts
OSServiceId_ResumeAllInterrupts
OSServiceId_SuspendAllInterrupts
OSServiceId_ResumeOSInterrupts
OSServiceId_SuspendOSInterrupts
OSServiceId_GetResource
OSServiceId_ReleaseResource
OSServiceId_ActivateTask
OSServiceId_ChainTask
OSServiceId_TerminateTask
OSServiceId_Schedule
OSServiceId_GetTaskID
OSServiceId_GetTaskState
OSServiceId_StartScheduleTableRel
OSServiceId_StartScheduleTableAbs
OSServiceId_StopScheduleTable
OSServiceId_NextScheduleTable
OSServiceId_GetScheduleTableStatus

Definition at line 23 of file ErrorTypes.h.

Data Structures

Macros

Typedefs

Enumerations

Detailed Description

Macro Definition Documentation

◆ OS_CALL_ERROR_HOOK

◆ OS_SET_ERROR_INFO0

◆ OS_SET_ERROR_INFO1

◆ OS_SET_ERROR_INFO2

◆ OS_SET_ERROR_INFO3

◆ OSError_ActivateTask_TaskID

◆ OSError_CancelAlarm_AlarmID

◆ OSError_ChainTask_TaskID

◆ OSError_ClearEvent_Mask

◆ OSError_GetAlarm_AlarmID

◆ OSError_GetAlarm_Tick

◆ OSError_GetAlarmBase_AlarmID

◆ OSError_GetAlarmBase_Info

◆ OSError_GetCounterValue_CounterID

◆ OSError_GetCounterValue_Value

◆ OSError_GetElapsedValue_CounterID

◆ OSError_GetElapsedValue_ElapsedValue

◆ OSError_GetElapsedValue_Value

◆ OSError_GetEvent_TaskID

◆ OSError_GetEvent_Type

◆ OSError_GetResource_ResID

◆ OSError_GetScheduleTableStatus_ScheduleStatus

◆ OSError_GetScheduleTableStatus_ScheduleTableID

◆ OSError_GetTaskID_TaskID

◆ OSError_GetTaskState_State

◆ OSError_GetTaskState_TaskID

◆ OSError_IncrementCounter_CounterID

◆ OSError_NextScheduleTable_ScheduleTableID_From

◆ OSError_NextScheduleTable_ScheduleTableID_To

◆ OSError_ReleaseResource_ResID

◆ OSError_SetAbsAlarm_AlarmID

◆ OSError_SetAbsAlarm_cycle

◆ OSError_SetAbsAlarm_start

◆ OSError_SetEvent_Mask

◆ OSError_SetEvent_TaskID

◆ OSError_SetRelAlarm_AlarmID

◆ OSError_SetRelAlarm_cycle

◆ OSError_SetRelAlarm_increment

◆ OSError_ShutdownOS_Error

◆ OSError_StartOS_Mode

◆ OSError_StartScheduleTableAbs_ScheduleTableID

◆ OSError_StartScheduleTableAbs_Start

◆ OSError_StartScheduleTableRel_Offset

◆ OSError_StartScheduleTableRel_ScheduleTableID

◆ OSError_StopScheduleTable_ScheduleTableID

◆ OSError_WaitEvent_Mask

◆ OSErrorGetServiceId

Typedef Documentation

◆ OSServiceIdType

Enumeration Type Documentation

◆ osServiceIdType