R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more information
Fork of
nrf51-sdk
by Lancaster University
« Back to documentation index
Types
struct nrf_radio_request_earliest_t Parameters for a request for a timeslot as early as possible. More... struct nrf_radio_request_normal_t Parameters for a normal radio request. More... struct nrf_radio_request_t Radio request parameters. More... struct nrf_radio_signal_callback_return_param_t Return parameters of the radio timeslot signal callback. More... struct nrf_ecb_hal_data_t AES ECB data structure. More... typedef volatile uint8_t nrf_mutex_t Represents a mutex for use with the nrf_mutex functions. typedef uint8_t nrf_app_irq_priority_t The interrupt priorities available to the application while the softdevice is active. typedef uint8_t nrf_power_mode_t Represents a power mode, used in power mode functions. typedef uint8_t nrf_power_failure_threshold_t Represents a power failure threshold value. typedef uint32_t nrf_power_dcdc_mode_t Represents a DCDC mode value. typedef uint8_t nrf_radio_notification_distance_t Radio notification distances. typedef uint8_t nrf_radio_notification_type_t Radio notification types. typedef nrf_radio_signal_callback_return_param_t *(* nrf_radio_signal_callback_t )(uint8_t signal_type) The radio signal callback type. enum NRF_SOC_SVCS The SVC numbers used by the SVC functions in the SoC library.
More... enum NRF_MUTEX_VALUES Possible values of a nrf_mutex_t .
More... enum NRF_APP_PRIORITIES Possible values of nrf_app_irq_priority_t .
More... enum NRF_POWER_MODES { NRF_POWER_MODE_CONSTLAT ,
NRF_POWER_MODE_LOWPWR
} Possible values of nrf_power_mode_t .
More... enum NRF_POWER_THRESHOLDS { NRF_POWER_THRESHOLD_V21 ,
NRF_POWER_THRESHOLD_V23 ,
NRF_POWER_THRESHOLD_V25 ,
NRF_POWER_THRESHOLD_V27
} Possible values of nrf_power_failure_threshold_t .
More... enum NRF_POWER_DCDC_MODES { NRF_POWER_DCDC_DISABLE ,
NRF_POWER_DCDC_ENABLE
} Possible values of nrf_power_dcdc_mode_t .
More... enum NRF_RADIO_NOTIFICATION_DISTANCES { NRF_RADIO_NOTIFICATION_DISTANCE_NONE = 0,
NRF_RADIO_NOTIFICATION_DISTANCE_800US ,
NRF_RADIO_NOTIFICATION_DISTANCE_1740US ,
NRF_RADIO_NOTIFICATION_DISTANCE_2680US ,
NRF_RADIO_NOTIFICATION_DISTANCE_3620US ,
NRF_RADIO_NOTIFICATION_DISTANCE_4560US ,
NRF_RADIO_NOTIFICATION_DISTANCE_5500US
Possible values of nrf_radio_notification_distance_t .
More... enum NRF_RADIO_NOTIFICATION_TYPES { NRF_RADIO_NOTIFICATION_TYPE_NONE = 0,
NRF_RADIO_NOTIFICATION_TYPE_INT_ON_ACTIVE ,
NRF_RADIO_NOTIFICATION_TYPE_INT_ON_INACTIVE ,
NRF_RADIO_NOTIFICATION_TYPE_INT_ON_BOTH
} Possible values of nrf_radio_notification_type_t .
More... enum NRF_SOC_EVTS { NRF_EVT_HFCLKSTARTED ,
NRF_EVT_POWER_FAILURE_WARNING ,
NRF_EVT_FLASH_OPERATION_SUCCESS ,
NRF_EVT_FLASH_OPERATION_ERROR ,
NRF_EVT_RADIO_BLOCKED ,
NRF_EVT_RADIO_CANCELED ,
NRF_EVT_RADIO_SIGNAL_CALLBACK_INVALID_RETURN ,
NRF_EVT_RADIO_SESSION_IDLE ,
NRF_EVT_RADIO_SESSION_CLOSED
SoC Events.
More... enum NRF_RADIO_CALLBACK_SIGNAL_TYPE { NRF_RADIO_CALLBACK_SIGNAL_TYPE_START ,
NRF_RADIO_CALLBACK_SIGNAL_TYPE_TIMER0 ,
NRF_RADIO_CALLBACK_SIGNAL_TYPE_RADIO ,
NRF_RADIO_CALLBACK_SIGNAL_TYPE_EXTEND_FAILED ,
NRF_RADIO_CALLBACK_SIGNAL_TYPE_EXTEND_SUCCEEDED
The Radio signal callback types.
More... enum NRF_RADIO_SIGNAL_CALLBACK_ACTION { NRF_RADIO_SIGNAL_CALLBACK_ACTION_NONE ,
NRF_RADIO_SIGNAL_CALLBACK_ACTION_EXTEND ,
NRF_RADIO_SIGNAL_CALLBACK_ACTION_END ,
NRF_RADIO_SIGNAL_CALLBACK_ACTION_REQUEST_AND_END
} The actions requested by the signal callback.
More... enum NRF_RADIO_HFCLK_CFG { NRF_RADIO_HFCLK_CFG_DEFAULT ,
NRF_RADIO_HFCLK_CFG_FORCE_XTAL
} Radio timeslot high frequency clock source configuration.
More... enum NRF_RADIO_PRIORITY { NRF_RADIO_PRIORITY_HIGH ,
NRF_RADIO_PRIORITY_NORMAL
} Radio timeslot priorities.
More... enum NRF_RADIO_REQUEST_TYPE { NRF_RADIO_REQ_TYPE_EARLIEST ,
NRF_RADIO_REQ_TYPE_NORMAL
} Radio timeslot request type.
More...
Typedef Documentation
The interrupt priorities available to the application while the softdevice is active.
Definition at line 229 of file nrf_soc.h .
Represents a mutex for use with the nrf_mutex functions.
Note: Accessing the value directly is not safe, use the mutex functions! Definition at line 226 of file nrf_soc.h .
Represents a DCDC mode value.
Definition at line 238 of file nrf_soc.h .
Represents a power failure threshold value.
Definition at line 235 of file nrf_soc.h .
Represents a power mode, used in power mode functions.
Definition at line 232 of file nrf_soc.h .
Radio notification distances.
Definition at line 241 of file nrf_soc.h .
Radio notification types.
Definition at line 244 of file nrf_soc.h .
The radio signal callback type.
Note: In case of invalid return parameters, the radio timeslot will automatically end immediately after returning from the signal callback and the NRF_EVT_RADIO_SIGNAL_CALLBACK_INVALID_RETURN event will be sent.
The returned struct pointer must remain valid after the signal callback function returns. For instance, this means that it must not point to a stack variable. Parameters:
Returns: Pointer to structure containing action requested by the application. Definition at line 348 of file nrf_soc.h .
Enumeration Type Documentation
Possible values of nrf_power_dcdc_mode_t .
Enumerator:
The DCDC is disabled.
The DCDC is enabled.
Definition at line 175 of file nrf_soc.h .
Possible values of nrf_power_mode_t .
Enumerator:
Constant latency mode.
See power management in the reference manual.
Low power mode.
See power management in the reference manual.
Definition at line 157 of file nrf_soc.h .
Possible values of nrf_power_failure_threshold_t .
Enumerator:
2.1 Volts power failure threshold.
2.3 Volts power failure threshold.
2.5 Volts power failure threshold.
2.7 Volts power failure threshold.
Definition at line 165 of file nrf_soc.h .
The Radio signal callback types.
Enumerator:
This signal indicates the start of the radio timeslot.
This signal indicates the NRF_TIMER0 interrupt.
This signal indicates the NRF_RADIO interrupt.
This signal indicates extend action failed.
This signal indicates extend action succeeded.
Definition at line 247 of file nrf_soc.h .
Radio timeslot high frequency clock source configuration.
Enumerator:
Use the currently selected oscillator as HF clock source during the timeslot (i.e.
the source is not specified).
Force external crystal to be used as HF clock source during whole the timeslot.
Definition at line 270 of file nrf_soc.h .
Possible values of nrf_radio_notification_distance_t .
Enumerator:
The event does not have a notification.
The distance from the active notification to start of radio activity.
The distance from the active notification to start of radio activity.
The distance from the active notification to start of radio activity.
The distance from the active notification to start of radio activity.
The distance from the active notification to start of radio activity.
The distance from the active notification to start of radio activity.
Definition at line 182 of file nrf_soc.h .
Possible values of nrf_radio_notification_type_t .
Enumerator:
The event does not have a radio notification signal.
Using interrupt for notification when the radio will be enabled.
Using interrupt for notification when the radio has been disabled.
Using interrupt for notification both when the radio will be enabled and disabled.
Definition at line 195 of file nrf_soc.h .
Radio timeslot priorities.
Enumerator:
High (equal priority as the normal connection priority of the SoftDevice stack(s)).
Normal (equal priority as the priority of secondary activites of the SoftDevice stack(s)).
Definition at line 277 of file nrf_soc.h .
Radio timeslot request type.
Enumerator:
Request timeslot as early as possible.
This should always be used for the first request in a session.
Normal timeslot request.
Definition at line 284 of file nrf_soc.h .
The actions requested by the signal callback.
This code gives the SOC instructions about what action to take when the signal callback has returned.
Enumerator:
Return without action.
Request an extension of the current timeslot (maximum execution time for this action is when the extension succeeded).
End the current radio timeslot.
Request a new radio timeslot and end the current timeslot.
Definition at line 261 of file nrf_soc.h .
SoC Events.
Enumerator:
Event indicating that the HFCLK has started.
Event indicating that a power failure warning has occurred.
Event indicating that the ongoing flash operation has completed successfully.
Event indicating that the ongoing flash operation has timed out with an error.
Event indicating that a radio timeslot was blocked.
Event indicating that a radio timeslot was canceled by SoftDevice.
Event indicating that a radio signal callback handler return was invalid.
Event indicating that a radio session is idle.
Event indicating that a radio session is closed.
Definition at line 204 of file nrf_soc.h .
The SVC numbers used by the SVC functions in the SoC library.
Definition at line 86 of file nrf_soc.h .
David Saul
Lancaster University
1.7.2