mhal_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 __MHAL_MBOX_H__
#define __MHAL_MBOX_H__

#include <mhal_osai.h>

#define MBOX_OK             0

#define MBOX_EDEFAULT           1

#define MBOX_EPTR           2

#define MBOX_EEMPTY         3

#define MBOX_EFULL          4

enum mbox_int_type {
    MBOX_INT_TYPE_NE,
    MBOX_INT_TYPE_WR,
    MBOX_INT_TYPE_NF,
    MBOX_INT_TYPE_RD,
    MBOX_INT_TYPE_MAX,
};

enum mbox_sem_status {
    MBOX_SEM_UNLOCK,
    MBOX_SEM_CM4_LOCK,
    MBOX_SEM_CA7_LOCK,
    MBOX_SEM_UNDEF,
};

typedef enum mbox_transfer_type {
    MBOX_TR_CMD_ONLY,
    MBOX_TR_DATA_CMD,
    MBOX_TR_MAX,
} mbox_tr_type_t;

typedef enum mbox_ioctl_type {
    MBOX_IOSET_NE_THRS,
    MBOX_IOGET_NE_THRS,
    MBOX_IOSET_NF_THRS,
    MBOX_IOGET_NF_THRS,
    MBOX_IOSET_SEM_POST,
    MBOX_IOSET_SEM_PEND,

    MBOX_IOSET_SWINT_TRIG,
    MBOX_IOSET_SWINT_EN,
    MBOX_IOGET_SWINT_EN,
    MBOX_IOSET_SWINT_CTRL,
    MBOX_IOGET_SWINT_STS,
    MBOX_IOSET_CLEAR_SWINT,

    MBOX_IOSET_INT_EN,
    MBOX_IOGET_INT_EN,
    MBOX_IOGET_INT_STS,
    MBOX_IOSET_CLEAR_INT,

    MBOX_IOGET_POST_FIFO_CNT,
    MBOX_IOGET_ACPT_FIFO_CNT
} mbox_ioctl_t;

struct mbox_fifo_item {
    u32 data;
    u32 cmd;
};

struct mbox_swint_arg {
    int enable;
    u32 id;
};

struct mbox_int_arg {
    enum mbox_int_type type;
    u32 enable;
};

struct mbox_fifo_event {
    u32 channel;
    u32 rd_int;
    u32 wr_int;
    u32 nf_sts;
    u32 ne_sts;
};

struct mbox_swint_info {
    u32 channel;
    u32 swint_sts;
};

#ifdef __cplusplus
extern "C" {
#endif

int mtk_mhal_mbox_reset(void __iomem *base);

int mtk_mhal_mbox_fifo_read(void __iomem *base, struct mbox_fifo_item *buf,
            mbox_tr_type_t type);

int mtk_mhal_mbox_fifo_write(void __iomem *base,
            const struct mbox_fifo_item *buf,
            mbox_tr_type_t type);

int mtk_mhal_mbox_ioctl(void __iomem *base,
            mbox_ioctl_t ctrl, void *arg);

#ifdef __cplusplus
}
#endif

#endif /* __MHAL_MBOX_H__ */