XPm_Notifier - 2023.1 English

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

XPm_Notifier - Notifier structure registered with a callback by app

Declaration

typedef struct
{
  void(*const callback)(struct XPm_Ntfier *const notifier),
  enum XPmNodeId node,
  enum XPmNotifyEvent event,
  u32 flags,
  volatile u32 oppoint,
  volatile u32 received,
  struct XPm_Ntfier * next
} XPm_Notifier;
Table 1. Structure XPm_Notifier member description
Member Description
callback

Custom callback handler to be called when the notification is received. The custom handler would execute from interrupt context, it shall return quickly and must not block! (enables event-driven notifications)

node

Node argument (the node to receive notifications about)

event

Event argument (the event type to receive notifications about)

flags

Flags

oppoint

Operating point of node in question. Contains the value updated when the last event notification is received. User shall not modify this value while the notifier is registered.

received

How many times the notification has been received - to be used by application (enables polling). User shall not modify this value while the notifier is registered.

next

Pointer to next notifier in linked list. Must not be modified while the notifier is registered. User shall not ever modify this value.