Public Types
enum	EState { eStaIdle = 0 , eStaSetup = 1 , eStaReady = 2 , eStaShutdown = 3 }

enum	{ eCnsGroupIdBits = 2 }

enum	{ eOptNone = 0x00000000 , eOptCategoryDc = 0x000000001 , eOptException = 0x000000002 , eOptExceptionEx = eOptNone }

enum	{ eFlgNone = 0x00000000 , eFlgDelete = 0x000000001 , eFlgNegative = 0x000000002 , eFlgPositive = 0x000000004 }

enum	{ eDcOrder = 20 , eDcCategory = 0xff , eDcCycletime = 0xffffffff , eDcCyclenumber = 0xff , eDcCoreId = 0x3f }

Public Member Functions
	CINOSBusHooks (uint8 auGroupId=0)
	Create bus hooks handler.

	~CINOSBusHooks ()
	Destroy bus hooks handler.

EState	GetState ()
	Get hooks handler state.

uint32	Setup (uint8 auCores=1, uint8 auCoreId=0, uint32 auOptions=eOptNone)
	Setup hooks handler with the given number of cores.

uint32	SetupCore (uint8 auCoreId, uint8 auCategories)
	Setup hook core handler.

uint32	SetupCategory (uint8 auCoreId, uint8 auCategory, uint32 auCycletimeNs, uint32 auFlags=CINOSBusHookCategory::eFlgEnabled)
	Setup hook category of given core handler.

uint32	SetupDone (uint16 auHooks)
	Finalysing hooks handler setup with given max. number of hooks.

uint32	Shutdown ()
	Shutdown hooks handler.

uint32	EnableCategory (uint8 auCategory)
	Enable given category of all cores.

uint32	EnableCategory (uint8 auCoreId, uint8 auCategory)
	Enable given category of given core.

uint32	DisableCategory (uint8 auCategory)
	Disable given category of all cores.

uint32	DisableCategory (uint8 auCoreId, uint8 auCategory)
	Disable given category of given core.

uint32	RegisterHook (uintid &aoHookId, void *apHandler, CINOSBusHook::EFlags auFlags=CINOSBusHook::eFlgEnabled)
	Register a hook with the given parameters.

uint32	RegisterHook (uintid &aoHookId, void apHandler, void apObject, CINOSBusHook::EFlags auFlags=CINOSBusHook::eFlgEnabled)
	Register a hook with the given parameters.

uint32	RegisterHook (uintid &aoHookId, void apHandler, void apObject, int32 aiOrder, CINOSBusHook::EFlags auFlags=CINOSBusHook::eFlgEnabled)
	Register a hook with the given parameters.

uint32	RegisterHook (uintid &aoHookId, void apHandler, void apObject, int32 aiOrder, uint8 auCategory, CINOSBusHook::EFlags auFlags=CINOSBusHook::eFlgEnabled)
	Register a hook with the given parameters.

uint32	RegisterHook (uintid &aoHookId, void apHandler, void apObject, int32 aiOrder, uint8 auCategory, uint32 auCycletime, CINOSBusHook::EFlags auFlags=CINOSBusHook::eFlgEnabled)
	Register a hook with the given parameters.

uint32	RegisterHook (uintid &aoHookId, void apHandler, void apObject, int32 aiOrder, uint8 auCategory, uint32 auCycletime, uint8 auCyclenumber, CINOSBusHook::EFlags auFlags=CINOSBusHook::eFlgEnabled)
	Register a hook with the given parameters.

uint32	RegisterHook (uintid &aoHookId, void apHandler, void apObject, int32 aiOrder, uint8 auCategory, uint32 auCycletime, uint8 auCyclenumber, uint8 auCoreId, CINOSBusHook::EFlags auFlags=CINOSBusHook::eFlgEnabled)
	Register a hook with the given parameters.

uint32	RegisterHook (CINOSBusHook *apHook)
	Register given hook.

uint32	UnregisterHook (uintid auHookId)
	Unregister given hook.

uint32	UnregisterHook (CINOSBusHook *apHook, uint32 auFlags=eFlgNone)
	Unregister given hook.

uint32	EnableHook (uintid auHookId)
	Enable given hook.

uint32	DisableHook (uintid auHookId)
	Disable given hook.

void *	GetHookHandler (uintid auHookId)
	Get hook handler.

uint32	SetHookHandler (uintid auHookId, void *apHandler)
	Set hook handler.

uint8	GetHookCyclenumber (uintid auHookId)
	Get hook cycle number.

uint32	GetHookCycleTime (uintid auHookId)
	Get hook cycle time.

uint32	GetHookCycleTime (uintid auHookId, uint32 &auCycletime)
	Get hook cycle time.

uint32	GetHookCategory (uintid auHookId, uint8 &auCategory)
	Get hook category.

uint32	MoveHooks (uint8 auCoreId, uint8 auSrc, uint8 auDst)
	Move all hooks of given core from one category to an other.

uint32	HandleHooks (uint8 auCategory=0, uint8 auCycle=0, uint32 auFlags=eFlgNone)
	Call all hook handlers of the given category and cycle assigned to the actual core id.

Static Public Member Functions
static uint32	GetGroupId (uintid auHookId)
	Get group id from hook id.

Protected Member Functions
uint32	RequestId (uintid &aoHookId)
	Request a hook id.

uint32	ReleaseId (uintid auHookId)
	Release given hook id.

uint32	GetIndex (uintid auHookId)
	Return hook index from given hook id.

bool	HasHooks (uint32 auNumber)
	Check whether the given number of hooks are still available.

uint32	iHookCheck (void apHandler, void apObject, int32 &aiOrder, uint8 &auCategory, uint32 &auCycletime, uint8 &auCyclenumber, uint8 &auCoreId)
	Check if the given hook parameters are valid.

uint32	iHookIdCheck (uintid auHookId, CINOSBusHook *&apHook)
	Check if the given hook id is valid.

uint32	iHookRegister (CINOSBusHook *apHook)
	Internal register given hook.

SINOSBusHookNode *	AllocNode ()
	Allocate a hook node.

void	FreeNode (SINOSBusHookNode *apNode)
	Free given hook node.

void	FreeNodes (SINOSBusHookNode *apNode)
	Free list of hook nodes.

SINOSBusHookNode *	ListGet (SINOSBusHookNode **apHead)
	Atomically detach list from given head and set head = nullptr.

bool	ListSet (SINOSBusHookNode *apHead, SINOSBusHookNode apList)
	Atomically try to set head of list.

void	ListInsert (SINOSBusHookNode &apHead, SINOSBusHookNode apNode)
	Insert node into list in ascending order.

void	ListDestroy (SINOSBusHookNode **apHead)
	Destroy given nodes list.

	DECLARE_DYNAMIC (CINOSBusHooks)

Protected Attributes
EState	m_eState = eStaIdle

uint32	m_uOptions = eOptNone

uint8	m_uGroupId {}

uint32	m_uHookIndexMask {}

uint32	m_uHookIdShift {}

std::atomic< uint32 >	m_uHookIdCnt = {1}

uint32	m_uHooksActive {}

uint32 *	m_pHooksActive {}

uint32	m_uHooksMax {}

std::atomic< int32 >	m_uHooksAct = {0}

CINOSBusHook **	m_pHooks {}

uint8	m_uCoreIdBase {}

uint8	m_uCores {}

CINOSBusHookCore *	m_pCores {}

uint32	m_uCycletimeSlowest {1000000}

std::atomic< uint32 >	m_uNodesMax = {0}

std::atomic< int32 >	m_iNodesAct = {0}

SINOSBusHookNode *	m_pNodes {}

CINCOObject *	m_pRegister {}

class CINCOBusHooksMain *	m_pInco {}

Static Protected Attributes
static class CINOSBusHooksHelper *	m_pInstance [DF_INOS_MAX_CORES]

Friends
class	CINOS1ms

class	CINOSBus

class	CINOSBusHookCycle

class	CINOSBusHookExTest

class	CINCOBusHooksMain

class	CINCOBusHooks

class	CINOSHwTarget

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
eCnsGroupIdBits	number of group id bits

◆ anonymous enum

anonymous enum

Enumerator
eOptCategoryDc	use 'don't care category' if the requested is not available
eOptException	throw an exception in case of an error (instead of a return value)
eOptExceptionEx	return always a value because exception handling not available

Constructor & Destructor Documentation

◆ CINOSBusHooks()

CINOSBusHooks::CINOSBusHooks ( uint8 auGroupId = 0 )

Create bus hooks handler.

Parameters

[in] auGroupId User group id (0..3, marker for all hookid's of this instance)

Member Function Documentation

◆ AllocNode()

SINOSBusHookNode * CINOSBusHooks::AllocNode ( )

inlineprotected

Allocate a hook node.

Returns: Pointer to allocated node

◆ DisableCategory() [1/2]

uint32 CINOSBusHooks::DisableCategory ( uint8 auCategory )

Disable given category of all cores.

Parameters

[in] auHookId Id of hook to be disabled

Returns: INOS_OK or an appropriate error

◆ DisableCategory() [2/2]

uint32 CINOSBusHooks::DisableCategory	(	uint8	auCoreId,
		uint8	auCategory
	)

Disable given category of given core.

Parameters

[in]	auCoreId	Requested core
[in]	auHookId	Id of hook to be disabled

Returns: INOS_OK or an appropriate error

◆ DisableHook()

uint32 CINOSBusHooks::DisableHook ( uintid auHookId )

Disable given hook.

Parameters

[in] auHookId Id of hook to be disabled

Returns: INOS_OK or an appropriate error

◆ EnableCategory() [1/2]

uint32 CINOSBusHooks::EnableCategory ( uint8 auCategory )

Enable given category of all cores.

Parameters

[in] auCategory Category to be enabled

Returns: INOS_OK or an appropriate error

◆ EnableCategory() [2/2]

uint32 CINOSBusHooks::EnableCategory	(	uint8	auCoreId,
		uint8	auCategory
	)

Enable given category of given core.

Parameters

[in]	auCoreId	Requested core
[in]	auCategory	Category to be enabled

Returns: INOS_OK or an appropriate error

◆ EnableHook()

uint32 CINOSBusHooks::EnableHook ( uintid auHookId )

Enable given hook.

Parameters

[in] auHookId Id of hook to be enabled

Returns: INOS_OK or an appropriate error

◆ FreeNode()

void CINOSBusHooks::FreeNode ( SINOSBusHookNode * apNode )

inlineprotected

Free given hook node.

Parameters

[in] apNode Pointer to hook node to be freed

◆ FreeNodes()

void CINOSBusHooks::FreeNodes ( SINOSBusHookNode * apNode )

inlineprotected

Free list of hook nodes.

Parameters

[in] apNode Pointer to list of nodes to be freed

◆ GetGroupId()

static uint32 CINOSBusHooks::GetGroupId ( uintid auHookId )

inlinestatic

Get group id from hook id.

Parameters

[in] auHookId Id of requested hook.

Returns: Group id

◆ GetHookCategory()

uint32 CINOSBusHooks::GetHookCategory	(	uintid	auHookId,
		uint8 &	auCategory
	)

Get hook category.

Parameters

[in]	auHookId	Id of requested hook.
[out]	auCategory	Category of hook.

Returns: INOS_OK or an appropriate error

◆ GetHookCyclenumber()

uint8 CINOSBusHooks::GetHookCyclenumber ( uintid auHookId )

Get hook cycle number.

Parameters

[in] auHookId Id of requested hook

Returns: Cyclenumber of hook

◆ GetHookCycleTime() [1/2]

uint32 CINOSBusHooks::GetHookCycleTime ( uintid auHookId )

Get hook cycle time.

Parameters

[in] auHookId Id of requested hook.

Returns: Cycle time of hook.

◆ GetHookCycleTime() [2/2]

uint32 CINOSBusHooks::GetHookCycleTime	(	uintid	auHookId,
		uint32 &	auCycletime
	)

Get hook cycle time.

Parameters

[in]	auHookId	Id of requested hook.
[out]	auCycletime	Cycletime of hook.

Returns: INOS_OK or an appropriate error

◆ GetHookHandler()

void * CINOSBusHooks::GetHookHandler ( uintid auHookId )

Get hook handler.

Parameters

[in] auHookId Id of requested hook

Returns: Pointer to hook handler or nullptr if invalid

◆ GetIndex()

uint32 CINOSBusHooks::GetIndex ( uintid auHookId )

inlineprotected

Return hook index from given hook id.

Parameters

[in] auHookI Id of hook

Returns: Index of hook in internal hook array

◆ GetState()

EState CINOSBusHooks::GetState ( )

inline

Get hooks handler state.

Returns: Actual hooks handler state

◆ HandleHooks()

uint32 CINOSBusHooks::HandleHooks	(	uint8	auCategory = `0`,
		uint8	auCycle = `0`,
		uint32	auFlags = `eFlgNone`
	)

Call all hook handlers of the given category and cycle assigned to the actual core id.

Parameters

[in]	auCategory	Requested category
[in]	auCycle	Requested cycle number
[in]	auFlags	Additional flags (e.g. eFlgPositive)

Returns: INOS_OK or an appropriate error

◆ HasHooks()

bool CINOSBusHooks::HasHooks ( uint32 auNumber )

inlineprotected

Check whether the given number of hooks are still available.

Parameters

[in] auNumber Min. number of hooks available

Returns: true if available, false otherwise

◆ iHookCheck()

uint32 CINOSBusHooks::iHookCheck	(	void *	apHandler,
		void *	apObject,
		int32 &	aiOrder,
		uint8 &	auCategory,
		uint32 &	auCycletime,
		uint8 &	auCyclenumber,
		uint8 &	auCoreId
	)

protected

Check if the given hook parameters are valid.

Parameters

[in]	apHandler	Pointer to function to be called
[in]	apObject	Pointer to object instance if apHandler is a class method
[in]	aiOrder	Requested order, see DF_INOS_BUS_HOOK_ORDER_DEFAULT
[in]	auCategory	Requested category
[in]	auCycletime	Requested cycle time
[in]	auCyclenumber	Requested cycle number
[in]	auCoreId	Requested core id

Returns: INOS_OK or an appropriate error

◆ iHookIdCheck()

uint32 CINOSBusHooks::iHookIdCheck	(	uintid	auHookId,
		CINOSBusHook *&	apHook
	)

protected

Check if the given hook id is valid.

Parameters

[in]	auHookId	Id to be checked
[out]	apHook	Pointer to hook or nullptr if id invalid

Returns: INOS_OK or an appropriate error

◆ iHookRegister()

uint32 CINOSBusHooks::iHookRegister ( CINOSBusHook * apHook )

protected

Internal register given hook.

Parameters

[in] apHook Pointer to hook to be registered

Returns: INOS_OK or an appropriate error

◆ ListDestroy()

void CINOSBusHooks::ListDestroy ( SINOSBusHookNode ** apHead )

protected

Destroy given nodes list.

Parameters

[in] apNode Pointer to head of list

◆ ListGet()

SINOSBusHookNode * CINOSBusHooks::ListGet ( SINOSBusHookNode ** apHead )

protected

Atomically detach list from given head and set head = nullptr.

Parameters

[in] apNode Pointer to head of list

Returns: Pointer to head of list or nullptr if not available

◆ ListInsert()

void CINOSBusHooks::ListInsert	(	SINOSBusHookNode *&	apHead,
		SINOSBusHookNode *	apNode
	)

protected

Insert node into list in ascending order.

Parameters

[in]	apHead	Pointer to head of list
[in]	apNode	Pointer to node to be inserted

Returns: true in case of success, false otherwise

◆ ListSet()

bool CINOSBusHooks::ListSet	(	SINOSBusHookNode **	apHead,
		SINOSBusHookNode *	apList
	)

protected

Atomically try to set head of list.

Parameters

[in]	apHead	Pointer to head of list
[in]	apList	Pointer to head of list to be set

Returns: true in case of success, false otherwise

◆ MoveHooks()

uint32 CINOSBusHooks::MoveHooks	(	uint8	auCoreId,
		uint8	auSrc,
		uint8	auDst
	)

Move all hooks of given core from one category to an other.

IMPORTANT: The system relies on the fact, that during the move, the hooks of the given categories are not touched (neither registered nor unregistered). Doing so anyway will end up in undefined behaviour!

Parameters

[in]	auCoreId	Requested core id
[in]	auSrc	Source category number
[in]	auDst	Destination category number

Returns: INOS_OK or an appropriate error

◆ RegisterHook() [1/8]

uint32 CINOSBusHooks::RegisterHook ( CINOSBusHook * apHook )

Register given hook.

Parameters

[in] apHook Pointer to hook to be registered

Returns: INOS_OK or an appropriate error