spi_bus_lock_bg_entry() function

Handle interrupt and closure of last operation. Should be called at the beginning of the ISR, when the ISR is acting as the acquiring processor.

Syntax

Show:

Summary

Declaration

Definition

from spi_share_hw_ctrl.h:410

bool spi_bus_lock_bg_entry(spi_bus_lock_handle_t lock);

Implemented in spi_bus_lock.c:771

Arguments

Argument

Description

lock

The SPI bus lock

Return value

false if the ISR has already touched the HW, should run closure of the last operation first; otherwise true if the ISR just start operating on the HW, closure should be skipped.

Related Functions

Found 21 other functions taking a spi_bus_lock_t argument:

Function

Description

lock_status_fetch()

bg_enable()

lock_status_fetch_set()

atomic operations to the status

spi_bus_lock_register_dev()

Attach a device onto an SPI bus lock. The returning handle is used to perform following requests for the attached device.

spi_bus_deinit_lock()

Free the resources used by an SPI bus lock.

spi_bus_lock_get_acquiring_dev()

Get the device acquiring the bus.

spi_bus_lock_set_bg_control()

Configure how the SPI bus lock enable the background operation.

spi_bus_init_lock()

Initialization & Deinitialization

bg_disable()

lock_status_fetch_clear()

lock_status_clear()

schedule_core()

Find the next acquiring processor according to the status. Will directly change the acquiring device if new one found. Cases: - BG should still be the acquiring processor (Return false): 1. Acquiring device has active BG bits: out_desired_dev = new acquiring device 2. No acquiring device, but BG active: out_desired_dev = randomly pick one device with active BG bits - BG should yield to the task (Return true): 3. Acquiring device has no active BG bits: out_desired_dev = new acquiring device 4. No acquiring device while no active BG bits: out_desired_dev=NULL Acquiring device task need to be resumed only when case 3. This scheduling can happen in either task or ISR, so `in_isr` or `bg_active` not touched.

spi_bus_lock_bg_exit()

Handle the scheduling of other acquiring devices, and control of HW operation status. If no BG request is found, call with `wip=false`. This function will return false, indicating there is incoming BG requests for the current acquiring device (or for all devices if there is no acquiring device) and the ISR needs retry. Otherwise may schedule a new acquiring processor (unblock the task) if there is, and return true. Otherwise if a BG request is started in this ISR, call with `wip=true` and the function will enable the interrupt to make the ISR be called again when the request is done. This function is safe and should still be called when the ISR just lost its acquiring processor role, but hasn't quit.

spi_bus_lock_bg_check_dev_acq()

Check whether there is device asking for the acquiring device, and the desired device for the next operation is also recommended.

spi_bus_main_set_lock()

Bus attributes Set bus lock for the main bus, called by startup code.

lock_status_init()

try_acquire_free_dev()

update_pend_core()

bg_entry_core()

bg_exit_core()

spi_bus_lock_bg_req_exist()

Check if there is any active BG requests.