sys_arch.c File Reference

---

Detailed Description

lwIP abstraction layer for AVR32 UC3.

• Compiler: GNU GCC for AVR32
• Supported devices: All AVR32 devices can be used.
• AppNote:

Author:

Atmel Corporation: http://www.atmel.com
Support and FAQ: http://support.atmel.no/

Definition in file sys_arch.c.

#include "lwip/debug.h"
#include "lwip/sys.h"
#include "lwip/opt.h"
#include "lwip/stats.h"

Go to the source code of this file.

Data Structures
struct	TimeoutlistPerThread
Defines
#define	SYS_ARCH_BLOCKING_TICKTIMEOUT   ((portTickType)10000)
Functions
u32_t	sys_arch_mbox_fetch (sys_mbox_t mbox, void **msg, u32_t timeout)
u32_t	sys_arch_mbox_tryfetch (sys_mbox_t mbox, void **msg)
sys_prot_t	sys_arch_protect (void)
u32_t	sys_arch_sem_wait (sys_sem_t sem, u32_t timeout)
struct sys_timeouts *	sys_arch_timeouts (void)
void	sys_arch_unprotect (sys_prot_t pval)
void	sys_init (void)
void	sys_mbox_free (sys_mbox_t mbox)
sys_mbox_t	sys_mbox_new (int size)
void	sys_mbox_post (sys_mbox_t mbox, void *msg)
err_t	sys_mbox_trypost (sys_mbox_t mbox, void *msg)
void	sys_sem_free (sys_sem_t sem)
sys_sem_t	sys_sem_new (u8_t count)
void	sys_sem_signal (sys_sem_t sem)
sys_thread_t	sys_thread_new (char *name, void(*thread)(void *arg), void *arg, int stacksize, int prio)
Variables
static u16_t	NbActiveThreads = 0
static struct TimeoutlistPerThread	Threads_TimeoutsList [SYS_THREAD_MAX]
volatile unsigned portLONG	ulCriticalNesting

---

Define Documentation

#define SYS_ARCH_BLOCKING_TICKTIMEOUT   ((portTickType)10000)

Definition at line 51 of file sys_arch.c.

Referenced by sys_arch_mbox_fetch(), sys_arch_sem_wait(), and sys_mbox_post().

---

Function Documentation

u32_t sys_arch_mbox_fetch	(	sys_mbox_t	mbox,
		void **	msg,
		u32_t	timeout
	)

Definition at line 267 of file sys_arch.c.

References SYS_ARCH_BLOCKING_TICKTIMEOUT.

{
  portTickType TickStart;
  portTickType TickStop;
  portTickType TickElapsed = (portTickType)(timeout*portTICK_RATE_MS); // Express the timeout in OS tick.
  void         *tempoptr;


  // NOTE: we assume mbox != SYS_MBOX_NULL; iow, we assume the calling function
  // takes care of checking the mbox validity before calling this function.
  
  if(msg == NULL)
  {
      msg = &tempoptr;
  }

  // NOTE: INCLUDE_xTaskGetSchedulerState must be set to 1 in FreeRTOSConfig.h
  // for xTaskGetTickCount() to be available.
  if( 0 == TickElapsed )
  {
    TickStart = xTaskGetTickCount();
    // If "timeout" is 0, the thread should be blocked until a message arrives.
    while( pdFALSE == xQueueReceive( mbox, &(*msg), SYS_ARCH_BLOCKING_TICKTIMEOUT ) );
  }
  else
  {
    TickStart = xTaskGetTickCount();
    if( pdFALSE == xQueueReceive( mbox, &(*msg), TickElapsed ) )
    {
      *msg = NULL; 
      // if the function times out, it should return SYS_ARCH_TIMEOUT.
      return( SYS_ARCH_TIMEOUT );
    }
  }
  // If the function gets a msg, it should return the number of ms spent waiting.
  TickStop = xTaskGetTickCount();
  // Take care of wrap-around.
  if( TickStop >= TickStart )
    TickElapsed = TickStop - TickStart;
  else
    TickElapsed = portMAX_DELAY - TickStart + TickStop ;
  return( TASK_DELAY_MS( TickElapsed ) );
}

u32_t sys_arch_mbox_tryfetch	(	sys_mbox_t	mbox,
		void **	msg
	)

Definition at line 316 of file sys_arch.c.

{
  void  *tempoptr;


  if(msg == NULL)
  {
    msg = &tempoptr;
  }
  if( pdFALSE == xQueueReceive( mbox, &(*msg), 0 ) )
    // if a message is not present in the mailbox, it immediately returns with
    // the code SYS_MBOX_EMPTY.
    return( SYS_MBOX_EMPTY );
  // On success 0 is returned.
  return( 0 );
}

sys_prot_t sys_arch_protect

(

void

)

Definition at line 416 of file sys_arch.c.

References vPortEnterCritical().

{
  vPortEnterCritical();
  return 1; // Not used
}

u32_t sys_arch_sem_wait	(	sys_sem_t	sem,
		u32_t	timeout
	)

Definition at line 154 of file sys_arch.c.

References SYS_ARCH_BLOCKING_TICKTIMEOUT.

{
  portTickType TickStart;
  portTickType TickStop;
  portTickType TickElapsed = (portTickType)(timeout*portTICK_RATE_MS); // Express the timeout in OS tick.


  // NOTE: we assume sem != SYS_SEM_NULL; iow, we assume the calling function
  // takes care of checking the sem validity before calling this function.

  // NOTE: INCLUDE_xTaskGetSchedulerState must be set to 1 in FreeRTOSConfig.h
  // for xTaskGetTickCount() to be available.
  if( 0 == TickElapsed )
  {
    TickStart = xTaskGetTickCount();
    // If timeout=0, then the function should block indefinitely.
    while( pdFALSE == xSemaphoreTake( sem, SYS_ARCH_BLOCKING_TICKTIMEOUT ) );
  }
  else
  {
    TickStart = xTaskGetTickCount();
    if( pdFALSE == xSemaphoreTake( sem, TickElapsed ) )
      // if the function times out, it should return SYS_ARCH_TIMEOUT.
      return( SYS_ARCH_TIMEOUT );
  }
  // If the function acquires the semaphore, it should return how many milliseconds
  // expired while waiting for the semaphore.
  TickStop = xTaskGetTickCount();
  // Take care of wrap-around.
  if( TickStop >= TickStart )
    TickElapsed = TickStop - TickStart;
  else
    TickElapsed = portMAX_DELAY - TickStart + TickStop ;
  return( TASK_DELAY_MS( TickElapsed ) );
}

struct sys_timeouts* sys_arch_timeouts

(

void

)

[read]

Definition at line 342 of file sys_arch.c.

References NbActiveThreads, TimeoutlistPerThread::pid, Threads_TimeoutsList, and TimeoutlistPerThread::timeouts.

{
  int                         i;
  sys_thread_t                pid;
  struct TimeoutlistPerThread *tl;


  // Get the current thread id.
  // Note: INCLUDE_xTaskGetCurrentTaskHandle must be set to 1 in FreeRTOSConfig.h
  // for xTaskGetCurrentTaskHandle() to be available.
  pid = xTaskGetCurrentTaskHandle( );

  for(i = 0; i < NbActiveThreads; i++)
  {
    tl = &(Threads_TimeoutsList[i]);
    if(tl->pid == pid)
    {
      return &(tl->timeouts);
    }
  }

  // If we're here, this means the scheduler gave the focus to the task as it was
  // being created(because of a higher priority). Since Threads_TimeoutsList[] 
  // update is done just after the task creation, the array is not up-to-date.
  // => the last array entry must be the one of the current task.
  return( &(Threads_TimeoutsList[NbActiveThreads].timeouts) );
}

void sys_arch_unprotect

(

sys_prot_t

pval

)

Definition at line 425 of file sys_arch.c.

References vPortExitCritical().

{
  vPortExitCritical();
}

void sys_init

(

void

)

Definition at line 72 of file sys_arch.c.

References NbActiveThreads, TimeoutlistPerThread::pid, SYS_THREAD_MAX, Threads_TimeoutsList, and TimeoutlistPerThread::timeouts.

{
  int i;


  // Initialize the the per-thread sys_timeouts structures
  // make sure there are no valid pids in the list
  for(i = 0; i < SYS_THREAD_MAX; i++)
  {
    Threads_TimeoutsList[i].pid = 0;
    Threads_TimeoutsList[i].timeouts.next = NULL;
  }

  // keep track of how many threads have been created
  NbActiveThreads = 0;
}

void sys_mbox_free

(

sys_mbox_t

mbox

)

Definition at line 221 of file sys_arch.c.

References SYS_MBOX_NULL.

{
  if( SYS_MBOX_NULL != mbox )
  {
#ifdef SYS_STATS
    lwip_stats.sys.mbox.used--;
#endif /* SYS_STATS */
    vQueueDelete( mbox );
  }
}

sys_mbox_t sys_mbox_new

(

int

size

)

Definition at line 197 of file sys_arch.c.

References SYS_MBOX_NULL.

{
  sys_mbox_t mBoxNew;


  mBoxNew = xQueueCreate( size, sizeof( void * ) );
#if SYS_STATS
  if( SYS_MBOX_NULL != mBoxNew )
  {
    lwip_stats.sys.mbox.used++;
    if (lwip_stats.sys.mbox.used > lwip_stats.sys.mbox.max)
    {
      lwip_stats.sys.mbox.max = lwip_stats.sys.mbox.used;
    }
  }
#endif /* SYS_STATS */
  return( mBoxNew );
}

void sys_mbox_post	(	sys_mbox_t	mbox,
		void *	msg
	)

Definition at line 235 of file sys_arch.c.

References SYS_ARCH_BLOCKING_TICKTIMEOUT.

{
  // NOTE: we assume mbox != SYS_MBOX_NULL; iow, we assume the calling function
  // takes care of checking the mbox validity before calling this function.
  while( pdTRUE != xQueueSend( mbox, &msg, SYS_ARCH_BLOCKING_TICKTIMEOUT ) );
}

err_t sys_mbox_trypost	(	sys_mbox_t	mbox,
		void *	msg
	)

Definition at line 246 of file sys_arch.c.

{
  if( errQUEUE_FULL == xQueueSend( mbox, &msg, 0 ) )
    return( ERR_MEM );
  else
    return( ERR_OK );
}

void sys_sem_free

(

sys_sem_t

sem

)

Definition at line 124 of file sys_arch.c.

References SYS_SEM_NULL.

Referenced by prvlwIPInit().

{
  if( SYS_SEM_NULL != sem )
  {
#ifdef SYS_STATS
    lwip_stats.sys.sem.used--;
#endif /* SYS_STATS */
    vQueueDelete( sem );
  }
}

sys_sem_t sys_sem_new

(

u8_t

count

)

Definition at line 95 of file sys_arch.c.

References SYS_SEM_NULL.

Referenced by prvlwIPInit().

{
  sys_sem_t  xSemaphore = SYS_SEM_NULL;

  portENTER_CRITICAL();

  vSemaphoreCreateBinary( xSemaphore );
  if( xSemaphore != SYS_SEM_NULL )
  {
#if SYS_STATS
    lwip_stats.sys.sem.used++;
    if (lwip_stats.sys.sem.used > lwip_stats.sys.sem.max) {
      lwip_stats.sys.sem.max = lwip_stats.sys.sem.used;
    }
#endif /* SYS_STATS */

    if( 0 == count )  // Means we want the sem to be unavailable at init state.
    {
      xSemaphoreTake( xSemaphore, 1);
    }
  }

  portEXIT_CRITICAL();

  return xSemaphore;
}

void sys_sem_signal

(

sys_sem_t

sem

)

Definition at line 137 of file sys_arch.c.

Referenced by tcpip_init_done().

{
  xSemaphoreGive( sem );
}

sys_thread_t sys_thread_new	(	char *	name,
		void(*)(void *arg)	thread,
		void *	arg,
		int	stacksize,
		int	prio
	)

Definition at line 378 of file sys_arch.c.

References NbActiveThreads, TimeoutlistPerThread::pid, and Threads_TimeoutsList.

Referenced by low_level_init(), and portTASK_FUNCTION().

{
  sys_thread_t    newthread;
  portBASE_TYPE   result;
  SYS_ARCH_DECL_PROTECT(protectionLevel);

  result = xTaskCreate( thread, (signed portCHAR *)name, stacksize, arg, prio, &newthread );

  // Need to protect this -- preemption here could be a problem!
  SYS_ARCH_PROTECT(protectionLevel);
  if( pdPASS == result )
  {
    // For each task created, store the task handle (pid) in the timers array.
    // This scheme doesn't allow for threads to be deleted
    Threads_TimeoutsList[NbActiveThreads++].pid = newthread;
  }
  else
  {
    newthread = NULL;
  }
  SYS_ARCH_UNPROTECT(protectionLevel);

  return( newthread );
}

---

Variable Documentation

u16_t NbActiveThreads = 0 [static]

Definition at line 67 of file sys_arch.c.

Referenced by sys_arch_timeouts(), sys_init(), and sys_thread_new().

struct TimeoutlistPerThread Threads_TimeoutsList[SYS_THREAD_MAX] [static]

Definition at line 64 of file sys_arch.c.

Referenced by sys_arch_timeouts(), sys_init(), and sys_thread_new().

volatile unsigned portLONG ulCriticalNesting

Definition at line 83 of file GCC/AVR32_UC3/port.c.

Referenced by vPortEnterCritical(), and vPortExitCritical().