/*
*********************************************************************************************************
*                                                uC/OS-II
*                                          The Real-Time Kernel
*                                          SEMAPHORE MANAGEMENT
*
*                          (c) Copyright 1992-2002, Jean J. Labrosse, Weston, FL
*                                           All Rights Reserved
*
* File : OS_SEM.C
* By   : Jean J. Labrosse
* 翻譯： likee
*********************************************************************************************************
*/

#ifndef  OS_MASTER_FILE
#include "includes.h"
#endif

#if OS_SEM_EN > 0
/*
*********************************************************************************************************
*                                           ACCEPT SEMAPHORE接受信號量
*
* Description: This function checks the semaphore to see if a resource is available or, if an event
*              occurred.  Unlike OSSemPend(), OSSemAccept() does not suspend the calling task if the
*              resource is not available or the event did not occur.
*
* Arguments  : pevent     is a pointer to the event control block
*
* Returns    : >  0       if the resource is available or the event did not occur the semaphore is
*                         decremented to obtain the resource.
*              == 0       if the resource is not available or the event did not occur or,
*                         if 'pevent' is a NULL pointer or,
*                         if you didn't pass a pointer to a semaphore
                                                        
*********************************************************************************************************
*/

#if OS_SEM_ACCEPT_EN > 0
INT16U  OSSemAccept (OS_EVENT *pevent)
{
#if OS_CRITICAL_METHOD == 3                           /* Allocate storage for CPU status register      */
    OS_CPU_SR  cpu_sr;
#endif    
    INT16U     cnt;


#if OS_ARG_CHK_EN > 0
    if (pevent == (OS_EVENT *)0) {                    /* Validate 'pevent'                             */
        return (0);
    }
    if (pevent->OSEventType != OS_EVENT_TYPE_SEM) {   /* Validate event block type                     */
        return (0);
    }
#endif
    OS_ENTER_CRITICAL();
    cnt = pevent->OSEventCnt;
    if (cnt > 0) {                                    /* See if resource is available                  */
        pevent->OSEventCnt--;                         /* Yes, decrement semaphore and notify caller    */
    }
    OS_EXIT_CRITICAL();
    return (cnt);                                     /* Return semaphore count                        */
}
#endif    

/*$PAGE*/
/*
*********************************************************************************************************
*                                           CREATE A SEMAPHORE
*
* Description: This function creates a semaphore.
*
* Arguments  : cnt           is the initial value for the semaphore.  If the value is 0, no resource is
*                            available (or no event has occurred).  You initialize the semaphore to a
*                            non-zero value to specify how many resources are available (e.g. if you have
*                            10 resources, you would initialize the semaphore to 10).
*
* Returns    : != (void *)0  is a pointer to the event control clock (OS_EVENT) associated with the
*                            created semaphore
*              == (void *)0  if no event control blocks were available
                                                             建立一個信號量
描述：建立一個信號量
參數：cnt：信號量的初始化值，如果為零，則沒有信號量可用（或者沒有事件發生）
                          用非零值初始化信號量則顯示它有多少可用資源，如果你有十個
                          資源，則初始化信號量為10
返回：!= (void *)0  指向事件控制塊結合建立的信號量的指針
*              == (void *)0  如果沒有可用事件控制塊
*********************************************************************************************************
*/

OS_EVENT  *OSSemCreate (INT16U cnt)
{
#if OS_CRITICAL_METHOD == 3                       /* Allocate storage for CPU status register */
    OS_CPU_SR  cpu_sr;
#endif    
    OS_EVENT  *pevent;


    if (OSIntNesting > 0) {                                /* See if called from ISR ...               */
        return ((OS_EVENT *)0);                            /* ... can't CREATE from an ISR             */
    }//中斷服務子程序不能調用此函數，所有建立信號彈量的工作必須在任務級
    //代碼中或者多任務啟動前完成
    OS_ENTER_CRITICAL();
    pevent = OSEventFreeList;                              /* Get next free event control block        */
	//從空余事件控制塊鏈表中獲得一個事件控制塊ECB
    if (OSEventFreeList != (OS_EVENT *)0) {                /* See if pool of free ECB pool was empty   */
//如果成功獲得，則調整空余事件控制塊鏈表。使之指向下一個空余的事件控制塊
        OSEventFreeList = (OS_EVENT *)OSEventFreeList->OSEventPtr;
    }
    OS_EXIT_CRITICAL();
    if (pevent != (OS_EVENT *)0) {                         /* Get an event control block               */
		//如果得到的事件控制塊可用，就將其的事件類型設置成信號量，
        pevent->OSEventType = OS_EVENT_TYPE_SEM;
        pevent->OSEventCnt  = cnt;                         /* Set semaphore value                      */
		//將信號量的初始值存入事件控制塊ECB中。
        pevent->OSEventPtr  = (void *)0;                   /* Unlink from ECB free list                */
		//將.OSEventPtr初始化為NULL，因為它不于屬于空余事件控制塊鏈表了。
        OS_EventWaitListInit(pevent);                      /* Initialize to 'nobody waiting' on sem.   */
		//對等待任務列表進行初始化，因為信號量正在初始化，這時沒有任何
		//任務等待該信號量，所以函數將.OSEventGrp()和.OSEventTbl[]清零
    }
    return (pevent);//返回調用函數一個指向事件控制塊ECB的指針
}

/*$PAGE*/
/*
*********************************************************************************************************
*                                         DELETE A SEMAPHORE
*
* Description: This function deletes a semaphore and readies all tasks pending on the semaphore.
*
* Arguments  : pevent        is a pointer to the event control block associated with the desired
*                            semaphore.
*
*              opt           determines delete options as follows:
*                            opt == OS_DEL_NO_PEND   Delete semaphore ONLY if no task pending
*                            opt == OS_DEL_ALWAYS    Deletes the semaphore even if tasks are waiting.
*                                                    In this case, all the tasks pending will be readied.
*
*              err           is a pointer to an error code that can contain one of the following values:
*                            OS_NO_ERR               The call was successful and the semaphore was deleted
*                            OS_ERR_DEL_ISR          If you attempted to delete the semaphore from an ISR
*                            OS_ERR_INVALID_OPT      An invalid option was specified
*                            OS_ERR_TASK_WAITING     One or more tasks were waiting on the semaphore
*                            OS_ERR_EVENT_TYPE       If you didn't pass a pointer to a semaphore
*                            OS_ERR_PEVENT_NULL      If 'pevent' is a NULL pointer.
*
* Returns    : pevent        upon error
*              (OS_EVENT *)0 if the semaphore was successfully deleted.
*
* Note(s)    : 1) This function must be used with care.  Tasks that would normally expect the presence of
*                 the semaphore MUST check the return code of OSSemPend().
*              2) OSSemAccept() callers will not know that the intended semaphore has been deleted unless
*                 they check 'pevent' to see that it's a NULL pointer.
*              3) This call can potentially disable interrupts for a long time.  The interrupt disable
*                 time is directly proportional to the number of tasks waiting on the semaphore.
*              4) Because ALL tasks pending on the semaphore will be readied, you MUST be careful in
*                 applications where the semaphore is used for mutual exclusion because the resource(s)
*                 will no longer be guarded by the semaphore.
                                              刪除一個信號量
描述：刪除一個信號量
參數：pevent：指向事件控制塊結合目標信號量的指針
                opt:決定刪除選項：
 *                            opt == OS_DEL_NO_PEND   沒有任務掛起的時候才刪除。
*                            opt == OS_DEL_ALWAYS    即使有任務等待也刪除信號量，這種情況下，
                                   所有掛起的任務將就緒
 *              err           可能包含指下信息的錯誤代碼的指針
*                            OS_NO_ERR               調用成功，信號量刪除
*                            OS_ERR_DEL_ISR          如果想從中斷服務子程序中刪除信號量
*                            OS_ERR_INVALID_OPT      指定了不合理的選項
*                            OS_ERR_TASK_WAITING    一個或者多個任務在信號量中等待
*                            OS_ERR_EVENT_TYPE      沒有傳遞指針到信號量
*                            OS_ERR_PEVENT_NULL      如果 'pevent'是一個空指針************
備注：刪除信號量之前，必須首先刪除操作該信號量的所有任務
*/

#if OS_SEM_DEL_EN > 0
OS_EVENT  *OSSemDel (OS_EVENT *pevent, INT8U opt, INT8U *err)
{
#if OS_CRITICAL_METHOD == 3                                /* Allocate storage for CPU status register */
    OS_CPU_SR  cpu_sr;
#endif    
    BOOLEAN    tasks_waiting;


    if (OSIntNesting > 0) {                                /* See if called from ISR ...               */
        *err = OS_ERR_DEL_ISR;                             /* ... can't DELETE from an ISR             */
        return (pevent);
    }//是不是在ISR中調用
#if OS_ARG_CHK_EN > 0
    if (pevent == (OS_EVENT *)0) {                         /* Validate 'pevent'                        */
        *err = OS_ERR_PEVENT_NULL;
        return (pevent);//非法的pevent
    }
    if (pevent->OSEventType != OS_EVENT_TYPE_SEM) {        /* Validate event block type                */
        *err = OS_ERR_EVENT_TYPE;
        return (pevent);//不是事件塊類型
    }
#endif
    OS_ENTER_CRITICAL();
    if (pevent->OSEventGrp != 0x00) {                      /* See if any tasks waiting on semaphore    */
		//如果有任務在等待
        tasks_waiting = TRUE;                              /* Yes                                      */
    } else {
        tasks_waiting = FALSE;                             /* No                                       */
    }
    switch (opt) {//刪除選項
        case OS_DEL_NO_PEND:                               /* Delete semaphore only if no task waiting */
//如果只有沒有任務等待的時候才刪除
             if (tasks_waiting == FALSE) {//真沒有任務等待
                 pevent->OSEventType = OS_EVENT_TYPE_UNUSED;//將事件控制塊標記為未用，并退回到
                 //空余ECB中，此操作允許該事件控制塊用于建立另一信號量
                 pevent->OSEventPtr  = OSEventFreeList;    /* Return Event Control Block to free list  */
				 //原空閑表頭變成老二了。
                 OSEventFreeList     = pevent;             /* Get next free event control block        */
				 //pevent指向新的空閑表頭
                 OS_EXIT_CRITICAL();
                 *err = OS_NO_ERR;//返回無錯
                 return ((OS_EVENT *)0);                   /* Semaphore has been deleted               */
             } else {//如果有任務等待
                 OS_EXIT_CRITICAL();
                 *err = OS_ERR_TASK_WAITING;
                 return (pevent);
             }

        case OS_DEL_ALWAYS:                                /* Always delete the semaphore              */
			//無論如何都要刪除
             while (pevent->OSEventGrp != 0x00) {          /* Ready ALL tasks waiting for semaphore    */
                 OS_EventTaskRdy(pevent, (void *)0, OS_STAT_SEM);
             }//使所有等待的任務就緒
             pevent->OSEventType = OS_EVENT_TYPE_UNUSED;//標記為未用
             pevent->OSEventPtr  = OSEventFreeList;        /* Return Event Control Block to free list  */
			 //原空閑表頭變成老二了。
             OSEventFreeList     = pevent;                 /* Get next free event control block        */
             //pevent指向新的空閑表頭
             OS_EXIT_CRITICAL();
             if (tasks_waiting == TRUE) {                  /* Reschedule only if task(s) were waiting  */
                 OS_Sched();                               /* Find highest priority task ready to run  */
				 //有任務等待的話，因為有任務就緒，所以要任務調度
             }
             *err = OS_NO_ERR;
             return ((OS_EVENT *)0);                       /* Semaphore has been deleted               */

        default://其它非法選項
             OS_EXIT_CRITICAL();
             *err = OS_ERR_INVALID_OPT;
             return (pevent);
    }
}
#endif

/*$PAGE*/