armfly/Project/conf/lwip/port/arch/sys_arch.c

/*
 * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
 * All rights reserved.
 *
 * 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. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 *
 * This file is part of the lwIP TCP/IP stack.
 *
 * Author: Adam Dunkels <[email protected]>
 *
 */
/*  Porting by Michael Vysotsky <[email protected]> August 2011   */

#define SYS_ARCH_GLOBALS

/* lwIP includes. */
#include "sys_arch.h"
#include "lwip/debug.h"
#include "lwip/def.h"
#include "lwip/mem.h"
#include "lwip/sys.h"
#include "string.h"

/*----------------------------------------------------------------------------*/
/*                      VARIABLES                                             */
/*----------------------------------------------------------------------------*/
static OS_MEM *pQueueMem, *pStackMem;

const void *const pvNullPointer = (mem_ptr_t *)0xffffffff;

#if defined(__GNUC__) /*!< GCC compiler */
__attribute__((aligned(4)))
INT8U                              pcQueueMemoryPool[MAX_QUEUES * sizeof(TQ_DESCR)];
__attribute__((aligned(4))) OS_STK LwIP_Task_Stk[LWIP_TASK_MAX * LWIP_STK_SIZE];

#elif defined(__CC_ARM) /*!< ARM compiler */
__align(4) INT8U pcQueueMemoryPool[MAX_QUEUES * sizeof(TQ_DESCR)];
__align(4) OS_STK LwIP_Task_Stk[LWIP_TASK_MAX * LWIP_STK_SIZE];

#elif defined(__ICCARM__) /*!< IAR compiler */
#pragma data_alignment = 4
INT8U  pcQueueMemoryPool[MAX_QUEUES * sizeof(TQ_DESCR)];
#pragma data_alignment = 4
OS_STK LwIP_Task_Stk[LWIP_TASK_MAX * LWIP_STK_SIZE];

#endif /* __CC_ARM */

INT8U LwIP_task_priopity_stask[LWIP_TASK_MAX];

#define OS_MS_PER_TICK (1000 / OS_TICKS_PER_SEC)

u32_t sys_now(void)
{
    return (OSTimeGet() * OS_MS_PER_TICK);
}

/*----------------------------------------------------------------------------*/
/*                      PROTOTYPES                                            */
/*----------------------------------------------------------------------------*/
/*--------------------Creates an empty mailbox.-------------------------------*/

err_t sys_mbox_new(sys_mbox_t *mbox, int size)
{
    /* prarmeter "size" can be ignored in your implementation. */
    u8_t     ucErr;
    PQ_DESCR pQDesc;
    pQDesc = OSMemGet(pQueueMem, &ucErr);

    LWIP_ASSERT("OSMemGet ", ucErr == OS_ERR_NONE);
    if (ucErr == OS_ERR_NONE)
    {
        if (size > MAX_QUEUE_ENTRIES)
        {
            size = MAX_QUEUE_ENTRIES;
        }
        pQDesc->pQ = OSQCreate(&(pQDesc->pvQEntries[0]), size);
        LWIP_ASSERT("OSQCreate ", pQDesc->pQ != NULL);

        if (pQDesc->pQ != NULL)
        {
            *mbox = pQDesc;
            return 0;
        }
        else
        {
            ucErr = OSMemPut(pQueueMem, pQDesc);
            *mbox = NULL;
            return ucErr;
        }
    }
    else
    {
        return -1;
    }
}

/*-----------------------------------------------------------------------------------*/
/*
  Deallocates a mailbox. If there are messages still present in the
  mailbox when the mailbox is deallocated, it is an indication of a
  programming error in lwIP and the developer should be notified.
*/
void sys_mbox_free(sys_mbox_t *mbox)
{
    u8_t       ucErr;
    sys_mbox_t m_box = *mbox;
    LWIP_ASSERT("sys_mbox_free ", m_box != SYS_MBOX_NULL);

    OSQFlush(m_box->pQ);

    (void)OSQDel(m_box->pQ, OS_DEL_NO_PEND, &ucErr);
    LWIP_ASSERT("OSQDel ", ucErr == OS_ERR_NONE);

    ucErr = OSMemPut(pQueueMem, m_box);
    LWIP_ASSERT("OSMemPut ", ucErr == OS_ERR_NONE);
    *mbox = NULL;
}

/*-----------------------------------------------------------------------------------*/
//   Posts the "msg" to the mailbox.
void sys_mbox_post(sys_mbox_t *mbox, void *msg)
{
    u8_t       i     = 0;
    sys_mbox_t m_box = *mbox;
    if (msg == NULL)
        msg = (void *)&pvNullPointer;
    /* try 10 times */
    while ((i < 10) && ((OSQPost(m_box->pQ, msg)) != OS_ERR_NONE))
    {
        i++;
        OSTimeDly(5);
    }
    LWIP_ASSERT("sys_mbox_post error!\n", i != 10);
}

/* Try to post the "msg" to the mailbox. */
err_t sys_mbox_trypost(sys_mbox_t *mbox, void *msg)
{
    sys_mbox_t m_box = *mbox;
    if (msg == NULL)
        msg = (void *)&pvNullPointer;

    if ((OSQPost(m_box->pQ, msg)) != OS_ERR_NONE)
    {
        return ERR_MEM;
    }
    return ERR_OK;
}

/*-----------------------------------------------------------------------------------*/
/*
  Blocks the thread until a message arrives in the mailbox, but does
  not block the thread longer than "timeout" milliseconds (similar to
  the sys_arch_sem_wait() function). The "msg" argument is a result
  parameter that is set by the function (i.e., by doing "*msg =
  ptr"). The "msg" parameter maybe NULL to indicate that the message
  should be dropped.

  The return values are the same as for the sys_arch_sem_wait() function:
  Number of milliseconds spent waiting or SYS_ARCH_TIMEOUT if there was a
  timeout.

  Note that a function with a similar name, sys_mbox_fetch(), is
  implemented by lwIP.
*/
u32_t sys_arch_mbox_fetch(sys_mbox_t *mbox, void **msg, u32_t timeout)
{
    u8_t       ucErr;
    u32_t      ucos_timeout, timeout_new;
    void      *temp;
    sys_mbox_t m_box = *mbox;
    /* convert to timetick */
    if (timeout != 0)
    {
        ucos_timeout = (timeout * OS_TICKS_PER_SEC) / 1000;
        if (ucos_timeout < 1)
        {
            ucos_timeout = 1;
        }
        else if (ucos_timeout > 65535) /* ucOS only support u16_t timeout */
        {
            ucos_timeout = 65535;
        }
    }
    else
        ucos_timeout = 0;

    timeout = OSTimeGet();

    temp = OSQPend(m_box->pQ, (u16_t)ucos_timeout, &ucErr);

    if (msg != NULL)
    {
        if (temp == (void *)&pvNullPointer)
            *msg = NULL;
        else
            *msg = temp;
    }

    if (ucErr == OS_ERR_TIMEOUT)
        timeout = SYS_ARCH_TIMEOUT;
    else
    {
        LWIP_ASSERT("OSQPend ", ucErr == OS_ERR_NONE);

        timeout_new = OSTimeGet();
        if (timeout_new > timeout)
            timeout_new = timeout_new - timeout;
        else
            timeout_new = 0xffffffff - timeout + timeout_new;
        /* convert to millisecond */
        timeout = timeout_new * 1000 / OS_TICKS_PER_SEC + 1;
    }
    return timeout;
}
/**
 * Check if an mbox is valid/allocated:
 * @param sys_mbox_t *mbox pointer mail box
 * @return 1 for valid, 0 for invalid
 */
int sys_mbox_valid(sys_mbox_t *mbox)
{
    sys_mbox_t m_box = *mbox;
    u8_t       ucErr;
    int        ret;
    OS_Q_DATA  q_data;
    memset(&q_data, 0, sizeof(OS_Q_DATA));
    ucErr = OSQQuery(m_box->pQ, &q_data);
    ret   = (ucErr < 2 && (q_data.OSNMsgs < q_data.OSQSize)) ? 1 : 0;
    return ret;
}
/**
 * Set an mbox invalid so that sys_mbox_valid returns 0
 */
void sys_mbox_set_invalid(sys_mbox_t *mbox) {}
/*
 *  Creates and returns a new semaphore. The "count" argument specifies
 *  the initial state of the semaphore. TBD finish and test
 */

err_t sys_sem_new(sys_sem_t *sem, u8_t count)
{
    u8_t err;

    *sem = OSSemCreate((u16_t)count);
    if (*sem == NULL)
    {
        return -1;
    }

    OSEventNameSet(*sem, "LWIP Sem", &err);
    LWIP_ASSERT("OSSemCreate ", *sem != NULL);
    return 0;
}
/*
  Blocks the thread while waiting for the semaphore to be
  signaled. If the "timeout" argument is non-zero, the thread should
  only be blocked for the specified time (measured in
  milliseconds).

  If the timeout argument is non-zero, the return value is the number of
  milliseconds spent waiting for the semaphore to be signaled. If the
  semaphore wasn't signaled within the specified time, the return value is
  SYS_ARCH_TIMEOUT. If the thread didn't have to wait for the semaphore
  (i.e., it was already signaled), the function may return zero.

  Notice that lwIP implements a function with a similar name,
  sys_sem_wait(), that uses the sys_arch_sem_wait() function.
*/
u32_t sys_arch_sem_wait(sys_sem_t *sem, u32_t timeout)
{
    u8_t  ucErr;
    u32_t ucos_timeout, timeout_new;

    if (timeout != 0)
    {
        ucos_timeout =
            (timeout * OS_TICKS_PER_SEC) / 1000; // convert to timetick
        if (ucos_timeout < 1)
        {
            ucos_timeout = 1;
        }
        else if (ucos_timeout > 65536) /* uC/OS only support u16_t pend */
        {
            ucos_timeout = 65535;
        }
    }
    else
        ucos_timeout = 0;

    timeout = OSTimeGet();

    OSSemPend(*sem, (u16_t)ucos_timeout, (u8_t *)&ucErr);
    /*  only when timeout! */
    if (ucErr == OS_ERR_TIMEOUT)
        timeout = SYS_ARCH_TIMEOUT;
    else
    {

        /* for pbuf_free, may be called from an ISR */
        timeout_new = OSTimeGet();
        if (timeout_new >= timeout)
            timeout_new = timeout_new - timeout;
        else
            timeout_new = 0xffffffff - timeout + timeout_new;
        /* convert to milisecond */
        timeout = (timeout_new * 1000 / OS_TICKS_PER_SEC + 1);
    }
    return timeout;
}

/*
 *       Signals a semaphore
 */

void sys_sem_signal(sys_sem_t *sem) { OSSemPost(*sem); }

/*
 *      Deallocates a semaphore
 */
void sys_sem_free(sys_sem_t *sem)
{
    u8_t ucErr;
    (void)OSSemDel(*sem, OS_DEL_ALWAYS, &ucErr);
    LWIP_ASSERT("OSSemDel ", ucErr == OS_ERR_NONE);
    *sem = NULL;
}
int sys_sem_valid(sys_sem_t *sem)
{
    OS_SEM_DATA sem_data;
    return (OSSemQuery(*sem, &sem_data) == OS_ERR_NONE) ? 1 : 0;
}

/** Set a semaphore invalid so that sys_sem_valid returns 0 */
void sys_sem_set_invalid(sys_sem_t *sem) {}

/*
 * Initialize sys arch
 */
void sys_init(void)
{
    u8_t ucErr;
    memset(LwIP_task_priopity_stask, 0, sizeof(LwIP_task_priopity_stask));
    /* init mem used by sys_mbox_t, use ucosII functions */
    pQueueMem = OSMemCreate((void *)pcQueueMemoryPool, MAX_QUEUES,
                            sizeof(TQ_DESCR), &ucErr);
    OSMemNameSet(pQueueMem, "LWIP mem", &ucErr);
    LWIP_ASSERT("sys_init: failed OSMemCreate Q", ucErr == OS_ERR_NONE);
    pStackMem = OSMemCreate((void *)LwIP_Task_Stk, LWIP_TASK_MAX,
                            LWIP_STK_SIZE * sizeof(OS_STK), &ucErr);
    OSMemNameSet(pQueueMem, "LWIP TASK STK", &ucErr);
    LWIP_ASSERT("sys_init: failed OSMemCreate STK", ucErr == OS_ERR_NONE);
}

/*-----------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------*/
// TBD
/*-----------------------------------------------------------------------------------*/
/*
  Starts a new thread with priority "prio" that will begin its execution in the
  function "thread()". The "arg" argument will be passed as an argument to the
  thread() function. The id of the new thread is returned. Both the id and
  the priority are system dependent.
*/
sys_thread_t sys_thread_new(const char *name, lwip_thread_fn thread, void *arg,
                            int stacksize, int prio)
{
    u8_t    ubPrio = LWIP_TASK_START_PRIO;
    u8_t    ucErr;
    int     i;
    OS_STK *task_stk;
    INT16U  task_id;

    arg = arg;

    if (prio)
    {
        ubPrio += (prio - 1);
        for (i = 0; i < LWIP_TASK_MAX; ++i)
        {
            if (LwIP_task_priopity_stask[i] == ubPrio)
                break;
        }

        if (i == LWIP_TASK_MAX)
        {
            for (i = 0; i < LWIP_TASK_MAX; ++i)
            {
                if (LwIP_task_priopity_stask[i] == 0)
                {
                    LwIP_task_priopity_stask[i] = ubPrio;
                    break;
                }
            }
            if (i == LWIP_TASK_MAX)
            {
                LWIP_ASSERT("sys_thread_new: there is no space for priority",
                            0);
                return (-1);
            }
        }
        else
        {
            prio = 0;
        }
    }
    else
    {
        LWIP_ASSERT("priority is invalid \r\n", 0);
        return (-1);
    }
    /* Search for a suitable priority */
    if (!prio)
    {
        ubPrio = LWIP_TASK_START_PRIO;
        while (ubPrio < (LWIP_TASK_START_PRIO + LWIP_TASK_MAX))
        {
            for (i = 0; i < LWIP_TASK_MAX; ++i)
                if (LwIP_task_priopity_stask[i] == ubPrio)
                {
                    ++ubPrio;
                    break;
                }
            if (i == LWIP_TASK_MAX)
                break;
        }
        if (ubPrio < (LWIP_TASK_START_PRIO + LWIP_TASK_MAX))
            for (i = 0; i < LWIP_TASK_MAX; ++i)
                if (LwIP_task_priopity_stask[i] == 0)
                {
                    LwIP_task_priopity_stask[i] = ubPrio;
                    break;
                }
        if (ubPrio >= (LWIP_TASK_START_PRIO + LWIP_TASK_MAX) ||
            i == LWIP_TASK_MAX)
        {
            LWIP_ASSERT("sys_thread_new: there is no free priority", 0);
            return (-1);
        }
    }
    if (stacksize > LWIP_STK_SIZE || !stacksize)
        stacksize = LWIP_STK_SIZE;
    /* get Stack from pool */
    task_stk = OSMemGet(pStackMem, &ucErr);
    if (ucErr != OS_ERR_NONE)
    {
        LWIP_ASSERT("sys_thread_new: impossible to get a stack", 0);
        return (-1);
    }
    task_id = ubPrio - LWIP_TASK_START_PRIO + 4; // LWIP_TSK_ID;
#if (OS_TASK_STAT_EN == 0)
    OSTaskCreate(thread, (void *)arg, &task_stk[stacksize - 1], ubPrio);
#else
    OSTaskCreateExt(thread, (void *)arg, &task_stk[stacksize - 1], ubPrio,
                    task_id, &task_stk[0], stacksize, (void *)0,
                    OS_TASK_OPT_STK_CHK | OS_TASK_OPT_STK_CLR |
                        OS_TASK_OPT_SAVE_FP);
#endif
    OSTaskNameSet(ubPrio, (u8_t *)name, &ucErr);

    return ubPrio;
}

/*
  This optional function does a "fast" critical region protection and returns
  the previous protection level. This function is only called during very short
  critical regions. An embedded system which supports ISR-based drivers might
  want to implement this function by disabling interrupts. Task-based systems
  might want to implement this by using a mutex or disabling tasking. This
  function should support recursive calls from the same task or interrupt. In
  other words, sys_arch_protect() could be called while already protected. In
  that case the return value indicates that it is already protected.

  sys_arch_protect() is only required if your port is supporting an operating
  system.
*/
sys_prot_t sys_arch_protect(void)
{
    sys_prot_t cpu_sr;

    cpu_sr = CPU_SR_Save();

    return cpu_sr;
}

/*
  This optional function does a "fast" set of critical region protection to the
  value specified by pval. See the documentation for sys_arch_protect() for
  more information. This function is only required if your port is supporting
  an operating system.
*/
void sys_arch_unprotect(sys_prot_t pval) { CPU_SR_Restore(pval); }