drivers/staging/media/atomisp/pci/hive_isp_css_include/host/event_fifo_public.h

Source file repositories/reference/linux-study-clean/drivers/staging/media/atomisp/pci/hive_isp_css_include/host/event_fifo_public.h

File Facts

System
Linux kernel
Corpus path
drivers/staging/media/atomisp/pci/hive_isp_css_include/host/event_fifo_public.h
Extension
.h
Size
1622 bytes
Lines
72
Domain
Driver Families
Bucket
drivers/staging
Inferred role
Driver Families: implementation source
Status
source implementation candidate

Why This File Exists

Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.

Dependency Surface

Detected Declarations

Annotated Snippet

#ifndef __EVENT_FIFO_PUBLIC_H
#define __EVENT_FIFO_PUBLIC_H

#include <type_support.h>
#include "system_local.h"

/*! Blocking read from an event source EVENT[ID]

 \param	ID[in]				EVENT identifier

 \return none, dequeue(event_queue[ID])
 */
STORAGE_CLASS_EVENT_H void event_wait_for(
    const event_ID_t		ID);

/*! Conditional blocking wait for an event source EVENT[ID]

 \param	ID[in]				EVENT identifier
 \param	cnd[in]				predicate

 \return none, if(cnd) dequeue(event_queue[ID])
 */
STORAGE_CLASS_EVENT_H void cnd_event_wait_for(
    const event_ID_t		ID,
    const bool				cnd);

/*! Blocking read from an event source EVENT[ID]

 \param	ID[in]				EVENT identifier

 \return dequeue(event_queue[ID])
 */
STORAGE_CLASS_EVENT_H hrt_data event_receive_token(
    const event_ID_t		ID);

/*! Blocking write to an event sink EVENT[ID]

 \param	ID[in]				EVENT identifier
 \param	token[in]			token to be written on the event

 \return none, enqueue(event_queue[ID])
 */
STORAGE_CLASS_EVENT_H void event_send_token(
    const event_ID_t		ID,
    const hrt_data			token);

/*! Query an event source EVENT[ID]

 \param	ID[in]				EVENT identifier

 \return !isempty(event_queue[ID])
 */
STORAGE_CLASS_EVENT_H bool is_event_pending(
    const event_ID_t		ID);

/*! Query an event sink EVENT[ID]

 \param	ID[in]				EVENT identifier

 \return !isfull(event_queue[ID])
 */
STORAGE_CLASS_EVENT_H bool can_event_send_token(
    const event_ID_t		ID);

#endif /* __EVENT_FIFO_PUBLIC_H */

Annotation

Implementation Notes