notifier.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2016 Intel Corporation. All rights reserved.
 *
 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
 */
 
#ifndef __SOF_LIB_NOTIFIER_H__
#define __SOF_LIB_NOTIFIER_H__
 
#include <rtos/bit.h>
#include <sof/list.h>
#include <rtos/spinlock.h>
#include <rtos/sof.h>
#include <stdint.h>
 
/* notifier target core masks */
#define NOTIFIER_TARGET_CORE_MASK(x)    (1 << (x))
#define NOTIFIER_TARGET_CORE_LOCAL  NOTIFIER_TARGET_CORE_MASK(cpu_get_id())
#define NOTIFIER_TARGET_CORE_ALL_MASK   0xFFFFFFFF

#define NOTIFIER_FLAG_AGGREGATE     BIT(0)
 
enum notify_id {
    NOTIFIER_ID_CPU_FREQ = 0,       /* struct clock_notify_data * */
    NOTIFIER_ID_SSP_FREQ,           /* struct clock_notify_data * */
    NOTIFIER_ID_KPB_CLIENT_EVT,     /* struct kpb_event_data * */
    NOTIFIER_ID_DMA_DOMAIN_CHANGE,      /* struct dma_chan_data * */
    NOTIFIER_ID_DMA_COPY,           /* struct dma_cb_data* */
    NOTIFIER_ID_DMA_IRQ,            /* struct dma_chan_data * */
    NOTIFIER_ID_DAI_TRIGGER,        /* struct dai_group * */
    NOTIFIER_ID_MIC_PRIVACY_STATE_CHANGE,   /* struct mic_privacy_settings * */
    NOTIFIER_ID_COUNT
};
 
struct notify {
    struct list_item list[NOTIFIER_ID_COUNT]; /* list of callback handles */
    struct k_spinlock lock; /* list lock */
};
 
struct notify_data {
    const void *caller;
    enum notify_id type;
    uint32_t data_size;
    void *data;
};
 
#ifdef CLK_SSP
#define NOTIFIER_CLK_CHANGE_ID(clk) \
    ((clk) == CLK_SSP ? NOTIFIER_ID_SSP_FREQ : NOTIFIER_ID_CPU_FREQ)
#else
#define NOTIFIER_CLK_CHANGE_ID(clk) NOTIFIER_ID_CPU_FREQ
#endif
 
struct notify **arch_notify_get(void);
 
typedef void (*notifier_callback_t)(void *receiver_data, enum notify_id event_type,
                    void *caller_data);

int notifier_register(void *receiver_data, void *caller_id_filter, enum notify_id event_type,
              notifier_callback_t callback, uint32_t flags);

void notifier_unregister(void *receiver_data_filter, void *caller_id_filter, enum notify_id type);

void notifier_unregister_all(void *receiver_data_filter, void *caller_id_filter);
 
void notifier_notify_remote(void);
 
/* data_size is required to manage cache coherency for notifications
 * across cores.
 */
void notifier_event(const void *caller_id, enum notify_id event_type, uint32_t core_mask,
            void *caller_data, uint32_t data_size);
 
void init_system_notify(struct sof *sof);
 
void free_system_notify(void);
 
static inline struct notify_data *notify_data_get(void)
{
    return sof_get()->notify_data;
}
 
#endif /* __SOF_LIB_NOTIFIER_H__ */