platform_init.h File Reference

Functions
int	main (void)
uint8_t	platform_get_chip_revision (void)
void	platform_init_complete (void)
void	platform_init_connectivity_module (void)
void	platform_init_external_devices (void)
void	platform_init_mcu_infrastructure (void)
void	platform_init_memory (void)
void	platform_init_peripheral_irq_priorities (void)
void	platform_init_rtos_irq_priorities (void)
void	platform_init_system_clocks (void)
wiced_result_t	wiced_platform_init (void)

Detailed Description

Defines platform initialisation functions called by CRT0

Function Documentation

main()

int main

(

void

)

Main

Parameters

[in]

void

Returns

: int

@usage

• Defined by RTOS or application and called by CRT0

Main function - starts ThreadX Called from the crt0 _start function

platform_get_chip_revision()

uint8_t platform_get_chip_revision ( void )

extern

Used to get MCU chip revision

Parameters

[in]

void

Returns

: uint8_t

@usage

• Defined internally in platforms/MCU/<MCU>/platform_init.c and called by wiced_platform_init()
• Weakly defined in WICED/platform/MCU/wiced_platform_common.c. MCU may override it as desired

platform_init_complete()

void platform_init_complete ( void )

extern

Used to run last step initialisation

Parameters

[in]

void

Returns

: void

@usage

• Defined internally in platforms/MCU/<MCU>/platform_init.c and called by CRT0
• Weakly defined in platforms/MCU/<MCU>/platform_init.c. Users may override it as desired

platform_init_connectivity_module()

void platform_init_connectivity_module ( void )

extern

Initialise connectivity module(s) This function initialises and puts connectivity modules (Wi-Fi, Bluetooth, etc) into their reset state

Parameters

[in]

void

Returns

: void

@usage

• Defined and used internally in platforms/MCU/<MCU>/platform_init.c

platform_init_external_devices()

void platform_init_external_devices ( void )

extern

Initialise external devices This function initialises and puts external peripheral devices on the board such as LEDs, buttons, sensors, etc into their reset state

Parameters

[in]

void

Returns

: void

@usage :

• MUST be defined in platforms/<Platform>/platform.c
• Called by platform_init_mcu_infrastructure()

platform_init_mcu_infrastructure()

void platform_init_mcu_infrastructure ( void )

extern

Initialise default MCU infrastructure This function initialises default MCU infrastructure such as watchdog

Parameters

[in]

void

Returns

: void

@usage

• Defined and used internally in platforms/MCU/<MCU>/platform_init.c

platform_init_memory()

void platform_init_memory ( void )

extern

Initialise memory subsystem This function initialises memory subsystem such as external RAM

Parameters

[in]

void

Returns

: void

@usage

• Defined internally in platforms/MCU/<MCU>/platform_init.c and called by CRT0
• Weakly defined in platforms/MCU/<MCU>/platform_init.c. Users may override it as desired

platform_init_peripheral_irq_priorities()

void platform_init_peripheral_irq_priorities ( void )

extern

Initialise priorities of interrupts used by the platform peripherals

Parameters

[in]

void

Returns

: void

@usage

• MUST be defined in platforms/<Platform>/platform.c
• Called by platform_init_mcu_infrastructure()

platform_init_rtos_irq_priorities()

void platform_init_rtos_irq_priorities ( void )

extern

Initialise priorities of interrupts used by the RTOS

Parameters

[in]

void

Returns

: void

@usage

• MUST be defined by the RTOS
• Called by platform_init_mcu_infrastructure()

platform_init_system_clocks()

void platform_init_system_clocks ( void )

extern

Initialise system clock(s) This function includes initialisation of PLL and switching to fast clock

Parameters

[in]

void

Returns

: void

@usage

• Defined internally in platforms/MCU/<MCU>/platform_init.c and called by CRT0
• Weakly defined in platforms/MCU/<MCU>/platform_init.c. Users may override it as desired

wiced_platform_init()

wiced_result_t wiced_platform_init

(

void

)

Initialise the platform during wiced_init

Returns

: result code