mcu/service/mertos/include/mer_service_task.h

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2018
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER 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 THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
*
* Filename:
* ---------
*   mer_service_task.h
*
* Project:
* --------
*   MERTOS
*
* Description:
* ------------
*   Declare data structures and functions for tasks.
*
* Author:
* -------
 * -------
*
*****************************************************************************/

#ifndef _MER_SERVICE_TASK_H_
#define _MER_SERVICE_TASK_H_

#include "mer_service_list.h"
#include "mer_service_types.h"
#include "mer_kernel_config_public.h"


#define MER_SERVICE_TASK_GET_TASKID_BYINDEX(tindex) &mer_kernel_task_info_table[tindex]
#define MER_SERVICE_TASK_GET_TASKID_BYNAME(tname) MER_SERVICE_TASK_GET_TASKID_BYINDEX(TINDEX_##tname)

#define MER_SERVICE_TASK_NAME_LEN 60

typedef enum
{
    MER_SERVICE_TYPE_TASK = 0,
    MER_SERVICE_TYPE_DPC = 1,
    MER_SERVICE_TYPE_NONE,
} mer_service_job_type;

typedef enum
{
    MER_SERVICE_WAIT = 1,
    MER_SERVICE_RUN = 2,
    MER_SERVICE_NO_ACTIVATE = 3,
    MER_SERVICE_SUSPEND_BEGIN = 4,
    MER_SERVICE_QUEUE_SUSPEND = 5,
    MER_SERVICE_EVENT_SUSPEND = 6,
    MER_SERVICE_SLEEP_SUSPEND = 7,
    MER_SERVICE_SEMA_SUSPEND = 8,
    MER_SERVICE_ENHMUTEX_SUSPEND = 9,
    MER_SERVICE_SUSPEND_END = 10,
} mer_service_task_state;

typedef void(*mer_service_task_main_func)(void);
typedef void(*mer_service_task_init_func)(void);

struct _mer_service_mail_queue;
typedef struct _mer_service_mail_queue *mer_service_mq_id;

struct _mer_service_sync_enhanced_mutex;
typedef struct _mer_service_sync_enhanced_mutex *mer_service_sync_enhanced_mutex_id;

typedef struct
{
    mer_mem_ptr                                 stack_ptr;
    mer_uint32                                  affinity_mask;
    mer_char                                    name[MER_SERVICE_TASK_NAME_LEN];
    mer_service_task_state                      state;
    mer_uint8                                   job_index;
    mer_service_job_type                        job_type;
    mer_uint32                                  context;
    mer_mem_ptr                                 stack_end;
    mer_service_task_main_func                  func_main;
    mer_uint32                                  last_execution_vpe;
    mer_uint32                                  stack_size;
    mer_service_mq_id                           mq;
    mer_service_sync_enhanced_mutex_id          wait_enhmutex;
    mer_service_dlist                           owned_enhmutex_dlist;  
    mer_uint8                                   inheritor_task_index;
    mer_uint8                                   priority; 
    mer_service_task_init_func                  func_init;
    mer_mem_ptr                                 reset_stack_ptr;
    mer_uint32                                  initial_affinity_mask;
    mer_uint32                                  suspend_max_delay;
} mer_service_task_cb;
typedef mer_service_task_cb *mer_service_task_id;

extern mer_service_task_cb mer_kernel_task_info_table[];

void mer_service_task_init();

MER_STATUS mer_service_task_create
(
    mer_service_task_state      state,
    mer_uint32                  priority,
    mer_uint32                  stack_size,
    mer_mem_ptr                 stack_ptr
);

void mer_service_task_show(mer_service_task_id taskid);


// DPC
typedef void(*mer_service_dpc_func)(void);

typedef struct
{
    mer_mem_ptr             stack_ptr;
    mer_uint32              affinity_mask;
    mer_char                name[MER_SERVICE_TASK_NAME_LEN];
    mer_service_task_state  state;
    mer_uint8               job_index;
    mer_service_job_type    job_type;
    mer_uint32              context;
    mer_mem_ptr             stack_end;
    mer_service_dpc_func    func_handle;
    mer_uint32              last_execution_vpe;
    mer_uint32              priority;
    mer_uint32              invoke_count;
    mer_uint32              stack_size;
    mer_uint8               next_dpc[MIPS_HW_VPE_NUM];
    mer_uint8               prev_dpc[MIPS_HW_VPE_NUM];
    mer_uint32              initial_affinity_mask;
} mer_service_dpc_cb;
typedef mer_service_dpc_cb *mer_service_dpc_id;

void mer_service_dpc_show(mer_service_dpc_id dpcid);

#endif /* _MER_SERVICE_TASK_H_ */