los_rpqueue.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2022-2022. All rights reserved.
 * Description: LiteOS Remote Processor Queue Module HeaderFile
 * Author: Huawei LiteOS Team
 * Create: 2022-11-11
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific prior written
 * permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --------------------------------------------------------------------------- */
 
#ifndef LOS_RPQUEUE_H
#define LOS_RPQUEUE_H
 
#ifdef LOS_CONFIG_WITHOUT_OS
#include "los_typedef.h"
#include "los_toolchain.h"
#include "los_errno.h"
#include "los_rpqueue_bsp.h"
#else
#include "los_typedef.h"
#include "los_hwi.h"
#include "los_task.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define LOS_RPQUEUE_OPTION_SYNC_MSG_SEND            0x0001U
#define LOS_RPQUEUE_ALIGN_SIZE                      8U
 
#define LOS_ERRNO_RPQUEUE_PTR_NULL                  LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x01)
 
#define LOS_ERRNO_RPQUEUE_CB_DAMAGED                LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x02)
 
#define LOS_ERRNO_RPQUEUE_INVALID                   LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x03)
 
#define LOS_ERRNO_RPQUEUE_WRITE_BUSY                LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x04)
 
#define LOS_ERRNO_RPQUEUE_BUF_EMPTY                 LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x05)
 
#define LOS_ERRNO_RPQUEUE_BUF_NOT_ENOUGH            LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x06)
 
#define LOS_ERRNO_RPQUEUE_WRITE_ERROR               LOS_ERRNO_OS_FATAL(LOS_MOD_RPQUEUE, 0x07)
 
#define LOS_ERRNO_RPQUEUE_SIZE_TOO_SMALL            LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x08)
 
#define LOS_ERRNO_RPQUEUE_READ_LOCK                 LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x09)
 
#define LOS_ERRNO_RPQUEUE_HEADER_DAMAGED            LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x0A)
 
#define LOS_ERRNO_RPQUEUE_INITED                    LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x0B)
 
#define LOS_ERRNO_RPQUEUE_SIZE_TOO_LARGE            LOS_ERRNO_OS_ERROR(LOS_MOD_RPQUEUE, 0x0C)
 
typedef struct {
    UINT32 timeout;    
    UINT8  option;     
    UINT8  cmd;        
} LosRpqueueSendCfg;
 
typedef VOID (*LosRpqueueCallback)(UINT8 cmd, UINT8 *data, UINT16 len);
 
UINT32 LOS_RpqueueInit(VOID *queue, UINT32 size, UINT32 option);
 
UINT32 LOS_RpqueueMaxSendSizeGet(VOID *queue, UINT16 *maxSendSize);
 
UINT32 LOS_RpqueueSend(VOID *queue, const UINT8 *data, UINT16 len, const LosRpqueueSendCfg *cfg);
 
UINT32 LOS_RpqueueRecv(VOID *queue, LosRpqueueCallback recvDataCb);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* LOS_RPQUEUE_H */