Skip to content

Commit

Permalink
Fixed missed port files + documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Cervenka Dusan <[email protected]>
  • Loading branch information
Hadatko committed Dec 5, 2022
1 parent 6e9e7c8 commit ea3c5b8
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 22 deletions.
26 changes: 14 additions & 12 deletions include/event_groups.h
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ typedef struct EventGroupDef_t * EventGroupHandle_t;

/*
* The type that holds event bits always matches TickType_t - therefore the
* number of bits it holds is set by configUSE_16_BIT_TICKS (16 bits if set to 1,
* 32 bits if set to 0.
* number of bits it holds is set by configTICK_BIT_WIDTH (16 bits if set to 0,
* 32 bits if set to 1, 64 bits if set to 2.
*
* \defgroup EventBits_t EventBits_t
* \ingroup EventGroup
Expand All @@ -112,11 +112,12 @@ typedef TickType_t EventBits_t;
*
* Although event groups are not related to ticks, for internal implementation
* reasons the number of bits available for use in an event group is dependent
* on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h. If
* configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit
* 0 to bit 7). If configUSE_16_BIT_TICKS is set to 0 then each event group has
* 24 usable bits (bit 0 to bit 23). The EventBits_t type is used to store
* event bits within an event group.
* on the configTICK_BIT_WIDTH setting in FreeRTOSConfig.h. If
* configTICK_BIT_WIDTH is 0 then each event group contains 8 usable bits (bit
* 0 to bit 7). If configTICK_BIT_WIDTH is set to 1 then each event group has
* 24 usable bits (bit 0 to bit 23). If configTICK_BIT_WIDTH is set to 2 then
* each event group has 56 usable bits (bit 0 to bit 53). The EventBits_t type
* is used to store event bits within an event group.
*
* @return If the event group was created then a handle to the event group is
* returned. If there was insufficient FreeRTOS heap available to create the
Expand Down Expand Up @@ -168,11 +169,12 @@ typedef TickType_t EventBits_t;
*
* Although event groups are not related to ticks, for internal implementation
* reasons the number of bits available for use in an event group is dependent
* on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h. If
* configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit
* 0 to bit 7). If configUSE_16_BIT_TICKS is set to 0 then each event group has
* 24 usable bits (bit 0 to bit 23). The EventBits_t type is used to store
* event bits within an event group.
* on the configTICK_BIT_WIDTH setting in FreeRTOSConfig.h. If
* configTICK_BIT_WIDTH is 0 then each event group contains 8 usable bits (bit
* 0 to bit 7). If configTICK_BIT_WIDTH is set to 1 then each event group has
* 24 usable bits (bit 0 to bit 23). If configTICK_BIT_WIDTH is set to 2 then
* each event group has 56 usable bits (bit 0 to bit 53). The EventBits_t type
* is used to store event bits within an event group.
*
* @param pxEventGroupBuffer pxEventGroupBuffer must point to a variable of type
* StaticEventGroup_t, which will be then be used to hold the event group's data
Expand Down
2 changes: 1 addition & 1 deletion portable/IAR/78K0R/portmacro.h
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ typedef portSTACK_TYPE StackType_t;
typedef short BaseType_t;
typedef unsigned short UBaseType_t;

#if (configUSE_16_BIT_TICKS==1)
#if ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_16 )
typedef unsigned int TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffff
#elif ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_32 )
Expand Down
4 changes: 2 additions & 2 deletions portable/IAR/ARM_CM4F/portmacro.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@
typedef long BaseType_t;
typedef unsigned long UBaseType_t;

#if ( configUSE_16_BIT_TICKS == 1 )
#if ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_16 )
typedef uint16_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffff
#else
#elif ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_32 )
typedef uint32_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffffffffUL

Expand Down
2 changes: 1 addition & 1 deletion portable/IAR/V850ES/portmacro.h
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ typedef long BaseType_t;
typedef unsigned long UBaseType_t;


#if (configUSE_16_BIT_TICKS==1)
#if ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_16 )
typedef uint16_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffff
#elif ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_32 )
Expand Down
4 changes: 2 additions & 2 deletions portable/MikroC/ARM_CM4F/portmacro.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@
typedef long BaseType_t;
typedef unsigned long UBaseType_t;

#if ( configUSE_16_BIT_TICKS == 1 )
#if ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_16 )
typedef uint16_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffff
#else
#elif ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_32 )
typedef uint32_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffffffffUL

Expand Down
4 changes: 2 additions & 2 deletions portable/RVDS/ARM_CM4F/portmacro.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@
typedef long BaseType_t;
typedef unsigned long UBaseType_t;

#if ( configUSE_16_BIT_TICKS == 1 )
#if ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_16 )
typedef uint16_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffff
#else
#elif ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_32 )
typedef uint32_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffffffffUL

Expand Down
4 changes: 2 additions & 2 deletions portable/ThirdParty/GCC/RP2040/port.c
Original file line number Diff line number Diff line change
Expand Up @@ -713,7 +713,7 @@ __attribute__( ( weak ) ) void vPortSetupTimerInterrupt( void )
/* reduce to range 0-24 */
ulBit |= ulBit << 8u;
ulBit >>= 8u;
#endif /* configUSE_16_BIT_TICKS */
#endif /* configTICK_BIT_WIDTH */
return ( EventBits_t ) ulBit;
}

Expand All @@ -723,7 +723,7 @@ __attribute__( ( weak ) ) void vPortSetupTimerInterrupt( void )
return (EventBits_t) 0xffu;
#elif ( configTICK_BIT_WIDTH == TICK_BIT_WIDTH_32 )
return ( EventBits_t ) 0xffffffu;
#endif /* configUSE_16_BIT_TICKS */
#endif /* configTICK_BIT_WIDTH */
}

void vPortLockInternalSpinUnlockWithWait( struct lock_core * pxLock, uint32_t ulSave )
Expand Down

0 comments on commit ea3c5b8

Please sign in to comment.