Mailboxes

Collaboration diagram for Mailboxes:

Functions
err_t	sys_mbox_new (sys_mbox_t *mbox, int size)
void	sys_mbox_post (sys_mbox_t *mbox, void *msg)
err_t	sys_mbox_trypost (sys_mbox_t *mbox, void *msg)
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)
void	sys_mbox_free (sys_mbox_t *mbox)
int	sys_mbox_valid (sys_mbox_t *mbox)
void	sys_mbox_set_invalid (sys_mbox_t *mbox)

Detailed Description

Function Documentation

sys_mbox_new()

err_t sys_mbox_new	(	sys_mbox_t *	mbox,
		int	size
	)

Create a new mbox of specified size

Parameters

mbox	pointer to the mbox to create
size	(minimum) number of messages in this mbox

Returns

ERR_OK if successful, another err_t otherwise

{
  osMessageQDef(QUEUE, size, void *);
 
  *mbox = osMessageCreate(osMessageQ(QUEUE), NULL);
 
#if SYS_STATS
      ++lwip_stats.sys.mbox.used;
      if (lwip_stats.sys.mbox.max < lwip_stats.sys.mbox.used) {
         lwip_stats.sys.mbox.max = lwip_stats.sys.mbox.used;
      }
#endif /* SYS_STATS */
 if (*mbox == NULL)
  return ERR_MEM;
 
 return ERR_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sys_mbox_post()

void sys_mbox_post	(	sys_mbox_t *	mbox,
		void *	msg
	)

Post a message to an mbox - may not fail -> blocks if full, only used from tasks not from ISR

Parameters

mbox	mbox to posts the message
msg	message to post (ATTENTION: can be NULL)

{
  while(osMessagePut(*mbox, (uint32_t)data, osWaitForever) != osOK);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sys_mbox_trypost()

err_t sys_mbox_trypost	(	sys_mbox_t *	mbox,
		void *	msg
	)

Try to post a message to an mbox - may fail if full or ISR

Parameters

mbox	mbox to posts the message
msg	message to post (ATTENTION: can be NULL)

{
err_t result;
 
   if ( osMessagePut(*mbox, (uint32_t)msg, 0) == osOK)
   {
      result = ERR_OK;
   }
   else {
      // could not post, queue must be full
      result = ERR_MEM;
 
#if SYS_STATS
      lwip_stats.sys.mbox.err++;
#endif /* SYS_STATS */
 
   }
 
   return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sys_arch_mbox_fetch()

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

Wait for a new message to arrive in the mbox

Parameters

mbox	mbox to get a message from
msg	pointer where the message is stored
timeout	maximum time (in milliseconds) to wait for a message (0 = wait forever)

Returns

time (in milliseconds) waited for a message, may be 0 if not waited or SYS_ARCH_TIMEOUT on timeout The returned time has to be accurate to prevent timer jitter!

{
  osEvent event;
  uint32_t starttime = osKernelSysTick();;
 
  if(timeout != 0)
  {
    event = osMessageGet (*mbox, timeout);
 
    if(event.status == osEventMessage)
    {
      *msg = (void *)event.value.v;
      return (osKernelSysTick() - starttime);
    }
    else
    {
      return SYS_ARCH_TIMEOUT;
    }
  }
  else
  {
    event = osMessageGet (*mbox, osWaitForever);
    *msg = (void *)event.value.v;
    return (osKernelSysTick() - starttime);
  }
}

Here is the call graph for this function:

sys_arch_mbox_tryfetch()

u32_t sys_arch_mbox_tryfetch	(	sys_mbox_t *	mbox,
		void **	msg
	)

Wait for a new message to arrive in the mbox

Parameters

mbox	mbox to get a message from
msg	pointer where the message is stored

Returns

0 (milliseconds) if a message has been received or SYS_MBOX_EMPTY if the mailbox is empty

{
  osEvent event;
 
  event = osMessageGet (*mbox, 0);
 
  if(event.status == osEventMessage)
  {
    *msg = (void *)event.value.v;
    return ERR_OK;
  }
  else
  {
    return SYS_MBOX_EMPTY;
  }
}

Here is the call graph for this function:

sys_mbox_free()

void sys_mbox_free

(

sys_mbox_t *

mbox

)

Delete an mbox

Parameters

mbox	mbox to delete

{
    if( osMessageWaiting(*mbox) )
    {
        /* Line for breakpoint.  Should never break here! */
        portNOP();
#if SYS_STATS
        lwip_stats.sys.mbox.err++;
#endif /* SYS_STATS */
 
        // TODO notify the user of failure.
    }
 
    osMessageDelete(*mbox);
 
#if SYS_STATS
     --lwip_stats.sys.mbox.used;
#endif /* SYS_STATS */
}

Here is the call graph for this function:

sys_mbox_valid()

int sys_mbox_valid

(

sys_mbox_t *

mbox

)

Check if an mbox is valid/allocated: return 1 for valid, 0 for invalid

{
  if (*mbox == SYS_MBOX_NULL)
    return 0;
  else
    return 1;
}

sys_mbox_set_invalid()

void sys_mbox_set_invalid

(

sys_mbox_t *

mbox

)

Set an mbox invalid so that sys_mbox_valid returns 0

{
  *mbox = SYS_MBOX_NULL;
}