Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
k_poll_event Struct Reference

Poll Event. More...

#include <kernel.h>

Data Fields

struct z_poller * poller
 PRIVATE - DO NOT TOUCH.
 
uint32_t tag:8
 optional user-specified tag, opaque, untouched by the API
 
uint32_t type:_POLL_NUM_TYPES
 bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)
 
uint32_t state:_POLL_NUM_STATES
 bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)
 
uint32_t mode:1
 mode of operation, from enum k_poll_modes
 
uint32_t unused:(32 - (0 + 8 + _POLL_NUM_TYPES + _POLL_NUM_STATES + 1 ))
 unused bits in 32-bit word
 
union { 
 
   void *   obj 
 
   void *   typed_K_POLL_TYPE_IGNORE 
 
   struct k_poll_signal *   signal 
 
   struct k_poll_signal *   typed_K_POLL_TYPE_SIGNAL 
 
   struct k_sem *   sem 
 
   struct k_sem *   typed_K_POLL_TYPE_SEM_AVAILABLE 
 
   struct k_fifo *   fifo 
 
   struct k_fifo *   typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE 
 
   struct k_queue *   queue 
 
   struct k_queue *   typed_K_POLL_TYPE_DATA_AVAILABLE 
 
   struct k_msgq *   msgq 
 
   struct k_msgq *   typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE 
 
};  
 per-type data
 

Detailed Description

Poll Event.

Field Documentation

◆ [union]

union { ... } k_poll_event

per-type data

◆ fifo

struct k_fifo* k_poll_event::fifo

◆ mode

uint32_t k_poll_event::mode

mode of operation, from enum k_poll_modes

◆ msgq

struct k_msgq* k_poll_event::msgq

◆ obj

void* k_poll_event::obj

◆ poller

struct z_poller* k_poll_event::poller

PRIVATE - DO NOT TOUCH.

◆ queue

struct k_queue* k_poll_event::queue

◆ sem

struct k_sem* k_poll_event::sem

◆ signal

struct k_poll_signal* k_poll_event::signal

◆ state

uint32_t k_poll_event::state

bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)

◆ tag

uint32_t k_poll_event::tag

optional user-specified tag, opaque, untouched by the API

◆ type

uint32_t k_poll_event::type

bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)

◆ typed_K_POLL_TYPE_DATA_AVAILABLE

struct k_queue * k_poll_event::typed_K_POLL_TYPE_DATA_AVAILABLE

◆ typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE

struct k_fifo * k_poll_event::typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE

◆ typed_K_POLL_TYPE_IGNORE

void * k_poll_event::typed_K_POLL_TYPE_IGNORE

◆ typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE

struct k_msgq * k_poll_event::typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE

◆ typed_K_POLL_TYPE_SEM_AVAILABLE

struct k_sem * k_poll_event::typed_K_POLL_TYPE_SEM_AVAILABLE

◆ typed_K_POLL_TYPE_SIGNAL

struct k_poll_signal * k_poll_event::typed_K_POLL_TYPE_SIGNAL

◆ unused

uint32_t k_poll_event::unused

unused bits in 32-bit word


The documentation for this struct was generated from the following file: