os_hal_mbox.h

/*
 * (C) 2005-2020 MediaTek Inc. All rights reserved.
 *
 * Copyright Statement:
 *
 * This MT3620 driver software/firmware and related documentation
 * ("MediaTek Software") are protected under relevant copyright laws.
 * The information contained herein is confidential and proprietary to
 * MediaTek Inc. ("MediaTek"). You may only use, reproduce, modify, or
 * distribute (as applicable) MediaTek Software if you have agreed to and been
 * bound by this Statement and the applicable license agreement with MediaTek
 * ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 *
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE
 * PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS
 * ANY AND ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NONINFRINGEMENT. NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH
 * RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
 * INCORPORATED IN, OR SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO
 * LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN MEDIATEK
 * SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE
 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S
 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED
 * HEREUNDER WILL BE ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY
 * RECEIVER TO MEDIATEK DURING THE PRECEDING TWELVE (12) MONTHS FOR SUCH
 * MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __OS_HAL_MBOX_H__
#define __OS_HAL_MBOX_H__

#include "mhal_mbox.h"

typedef enum {
    OS_HAL_MBOX_CH0 = 0,
    OS_HAL_MBOX_CH1 = 1,
    OS_HAL_MBOX_CH_MAX
} mbox_channel_t;

#define MBOX_NUM_SW_INT             (8)

struct mtk_os_hal_mbox_cb_data {
    struct mbox_fifo_event event;
    struct mbox_swint_info swint;
};

typedef void (*mtk_os_hal_mbox_cb)(struct mtk_os_hal_mbox_cb_data *data);

#ifdef __cplusplus
extern "C" {
#endif

int mtk_os_hal_mbox_open_channel(mbox_channel_t channel);

int mtk_os_hal_mbox_close_channel(mbox_channel_t channel);

int mtk_os_hal_mbox_fifo_read(mbox_channel_t channel,
            struct mbox_fifo_item *buf, mbox_tr_type_t type);

int mtk_os_hal_mbox_fifo_write(mbox_channel_t channel,
        const struct mbox_fifo_item *buf, mbox_tr_type_t type);

int mtk_os_hal_mbox_ioctl(mbox_channel_t channel, mbox_ioctl_t ctrl,
            void *arg);

int mtk_os_hal_mbox_sw_int_register_cb(mbox_channel_t channel,
            mtk_os_hal_mbox_cb cb, u32 irq_status);

int mtk_os_hal_mbox_sw_int_unregister_cb(mbox_channel_t channel);

int mtk_os_hal_mbox_fifo_register_cb(mbox_channel_t channel,
            mtk_os_hal_mbox_cb cb, struct mbox_fifo_event *mask);

int mtk_os_hal_mbox_fifo_unregister_cb(mbox_channel_t channel);

#ifdef __cplusplus
}
#endif

#endif /* __OS_HAL_MBOX_H__ */