/*
 * Copyright (c) 2009-2022 Huawei Technologies Co., Ltd. All rights reserved.
 *
 * UniProton is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *          http://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 * Create: 2009-12-22
 * Description: 队列模块内部头文件。
 */
#ifndef PRT_QUEUE_EXTERNAL_H
#define PRT_QUEUE_EXTERNAL_H

#include "prt_queue.h"
#include "prt_list_external.h"
#include "prt_cpu_external.h"

/* 模块间宏定义 */
#define OS_QUEUE_NODE_HEAD_LEN (sizeof(struct QueNode) - 2)

/* 队列状态 */
#define OS_QUEUE_UNUSED 0 /* 队列没有使用 */
#define OS_QUEUE_USED 1 /* 已经被使用 */

#define OS_QUEUE_PID_INVALID       0xFFFFU /* 节点未使用 */
#define OS_QUEUE_NODE_SIZE_ALIGN   0x2U

#define GET_QUEUE_HANDLE(queueId) (((struct TagQueCb *)g_allQueue) + (queueId))

#define OS_QUEUE_INNER_ID(queueId)  ((queueId) - 1)
#define OS_QUEUE_ID(innerId)  ((innerId) + 1)

#define OS_QUEUE_NAME_LEN   16

/* 队列控制块结构体 */
struct TagQueCb {
    /* 队列起始地址指针 */
    U8 *queue;
    /* 队列状态 */
    U16 queueState;
    /* 队列长度(队列节点个数) */
    U16 nodeNum;
    /* 每个节点长度，单位word */
    U16 nodeSize;
    /* 当前队列头下标 */
    U16 queueHead;
    /* 当前队列尾下标 */
    U16 queueTail;
    /* 队列节点使用的峰值 */
    U16 nodePeak;
    /* 队列写资源计数器 */
    U16 writableCnt;
    /* 队列读资源计数器 */
    U16 readableCnt;
    /* 写队列超时LIST */
    struct TagListObject writeList;
    /* 读队列超时LIST */
    struct TagListObject readList;
};

/* 队列节点的数据结构 */
struct QueNode {
    /* 源PID */
    U16 srcPid;
    /* 节点长度 */
    U16 size;
    /* buf是初始化申请的，长度>=1 */
    U8 buf[2];
};

/* 队列最大个数 */
extern U16 g_maxQueue;
extern struct TagQueCb *g_allQueue;

#endif /* PRT_QUEUE_EXTERNAL_H */