JunMo Hong / stm-spirit1-rf-driver_for_cubebite

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of EV-COG-AD3029LZ by JunMo Hong

Embed: (wiki syntax)

« Back to documentation index

GPIO Private Functions
Functions

GPIO Private Functions
[GPIO]

Functions

void SpiritGpioInit (SGpioInit *pxGpioInitStruct)
 Initializes the SPIRIT GPIOx according to the specified parameters in the pxGpioInitStruct.
void SpiritGpioTemperatureSensor (SpiritFunctionalState xNewState)
 Enables or Disables the output of temperature sensor on SPIRIT GPIO_0.
void SpiritGpioSetLevel (SpiritGpioPin xGpioX, OutputLevel xLevel)
 Forces SPIRIT GPIO_x configured as digital output, to VDD or GND.
OutputLevel SpiritGpioGetLevel (SpiritGpioPin xGpioX)
 Returns output value (VDD or GND) of SPIRIT GPIO_x, when it is configured as digital output.
void SpiritGpioClockOutput (SpiritFunctionalState xNewState)
 Enables or Disables the MCU clock output.
void SpiritGpioClockOutputInit (ClockOutputInit *pxClockOutputInitStruct)
 Initializes the SPIRIT Clock Output according to the specified parameters in the xClockOutputInitStruct.
void SpiritGpioSetXOPrescaler (ClockOutputXOPrescaler xXOPrescaler)
 Sets the XO ratio as clock output.
ClockOutputXOPrescaler SpiritGpioGetXOPrescaler (void)
 Returns the settled XO prescaler as clock output.
void SpiritGpioSetRCOPrescaler (ClockOutputRCOPrescaler xRCOPrescaler)
 Sets the RCO ratio as clock output.
ClockOutputRCOPrescaler SpiritGpioGetRCOPrescaler (void)
 Returns the settled RCO prescaler as clock output.
void SpiritGpioSetExtraClockCycles (ExtraClockCycles xExtraCycles)
 Sets the RCO ratio as clock output.
ExtraClockCycles SpiritGpioGetExtraClockCycles (void)
 Returns the settled RCO prescaler as clock output.

Function Documentation

void SpiritGpioClockOutput ( SpiritFunctionalState  xNewState )

Enables or Disables the MCU clock output.

Parameters:
xNewStatenew state for the MCU clock output. This parameter can be: S_ENABLE or S_DISABLE.
Return values:
None.

Definition at line 253 of file SPIRIT_Gpio.c.

void SpiritGpioClockOutputInit ( ClockOutputInit *  pxClockOutputInitStruct )

Initializes the SPIRIT Clock Output according to the specified parameters in the xClockOutputInitStruct.

Parameters:
pxClockOutputInitStructpointer to a ClockOutputInit structure that contains the configuration information for the SPIRIT Clock Output.
Return values:
None.
Note:
The function SpiritGpioClockOutput() must be called in order to enable or disable the MCU clock dividers.

Definition at line 287 of file SPIRIT_Gpio.c.

ExtraClockCycles SpiritGpioGetExtraClockCycles ( void   )

Returns the settled RCO prescaler as clock output.

Parameters:
None.
Return values:
ExtraClockCyclesSettled number of extra clock cycles provided before switching to STANDBY state. This parameter can be any value of ExtraClockCycles .

Definition at line 429 of file SPIRIT_Gpio.c.

OutputLevel SpiritGpioGetLevel ( SpiritGpioPin  xGpioX )

Returns output value (VDD or GND) of SPIRIT GPIO_x, when it is configured as digital output.

Parameters:
xGpioXSpecifies the GPIO to be read. This parameter can be one of following parameters:

  • SPIRIT_GPIO_0: SPIRIT GPIO_0
  • SPIRIT_GPIO_1: SPIRIT GPIO_1
  • SPIRIT_GPIO_2: SPIRIT GPIO_2
  • SPIRIT_GPIO_3: SPIRIT GPIO_3
Return values:
OutputLevelLogical level of selected GPIO configured as digital output. This parameter can be: HIGH or LOW.

Definition at line 220 of file SPIRIT_Gpio.c.

ClockOutputRCOPrescaler SpiritGpioGetRCOPrescaler ( void   )

Returns the settled RCO prescaler as clock output.

Parameters:
None.
Return values:
ClockOutputRCOPrescalerSettled RCO prescaler used for clock output. This parameter can be a value of ClockOutputRCOPrescaler.

Definition at line 383 of file SPIRIT_Gpio.c.

ClockOutputXOPrescaler SpiritGpioGetXOPrescaler ( void   )

Returns the settled XO prescaler as clock output.

Parameters:
None.
Return values:
ClockOutputXOPrescalerSettled XO prescaler used for clock output. This parameter can be a value of ClockOutputXOPrescaler .

Definition at line 338 of file SPIRIT_Gpio.c.

void SpiritGpioInit ( SGpioInit *  pxGpioInitStruct )

Initializes the SPIRIT GPIOx according to the specified parameters in the pxGpioInitStruct.

Parameters:
pxGpioInitStructpointer to a SGpioInit structure that contains the configuration information for the specified SPIRIT GPIO.
Return values:
None.

Definition at line 119 of file SPIRIT_Gpio.c.

void SpiritGpioSetExtraClockCycles ( ExtraClockCycles  xExtraCycles )

Sets the RCO ratio as clock output.

Parameters:
xExtraCyclesthe number of extra clock cycles provided before switching to STANDBY state. This parameter can be any value of ExtraClockCycles .
Return values:
None.

Definition at line 402 of file SPIRIT_Gpio.c.

void SpiritGpioSetLevel ( SpiritGpioPin  xGpioX,
OutputLevel  xLevel 
)

Forces SPIRIT GPIO_x configured as digital output, to VDD or GND.

Parameters:
xGpioXSpecifies the GPIO to be configured. This parameter can be one of following parameters:

  • SPIRIT_GPIO_0: SPIRIT GPIO_0
  • SPIRIT_GPIO_1: SPIRIT GPIO_1
  • SPIRIT_GPIO_2: SPIRIT GPIO_2
  • SPIRIT_GPIO_3: SPIRIT GPIO_3
xLevelSpecifies the level. This parameter can be: HIGH or LOW.
Return values:
None.

Definition at line 181 of file SPIRIT_Gpio.c.

void SpiritGpioSetRCOPrescaler ( ClockOutputRCOPrescaler  xRCOPrescaler )

Sets the RCO ratio as clock output.

Parameters:
xRCOPrescalerthe RCO prescaler to be used as clock output. This parameter can be any value of ClockOutputRCOPrescaler .
Return values:
None.

Definition at line 357 of file SPIRIT_Gpio.c.

void SpiritGpioSetXOPrescaler ( ClockOutputXOPrescaler  xXOPrescaler )

Sets the XO ratio as clock output.

Parameters:
xXOPrescalerthe XO prescaler to be used as clock output. This parameter can be any value of ClockOutputXOPrescaler .
Return values:
None

Definition at line 312 of file SPIRIT_Gpio.c.

void SpiritGpioTemperatureSensor ( SpiritFunctionalState  xNewState )

Enables or Disables the output of temperature sensor on SPIRIT GPIO_0.

Parameters:
xNewStatenew state for temperature sensor. This parameter can be: S_ENABLE or S_DISABLE.
Return values:
None.

Definition at line 141 of file SPIRIT_Gpio.c.

Generated on Wed Jul 13 2022 17:25:38 by  doxygen 1.7.2