1.1.2.7.1 DRV_AK4954_LRCLK_Sync Function

uint32_t DRV_AK4954_LRCLK_Sync (const DRV_HANDLE handle);

Summary

Synchronize to the start of the I2S LRCLK (left/right clock) signal

Description

This function waits until low-to high transition of the I2S LRCLK (left/right clock) signal (high-low if Left-Justified format, this is determined by the PLIB). In the case where this signal is generated from a codec or other external source, this allows the caller to synchronize calls to the DMA with the LRCLK signal so the left/right channel association is valid.

Preconditions

None.

Parameters

ParametersDescription
handleA valid open-instance handle, returned from the driver's open routine

Returns

True - if the function was successful

False - if a timeout occurred (no transitions seen)

Remarks

None.

Example

_\/\/ myAK4954Handle is the handle returned_ _\/\/ by the DRV_AK4954_Open function._

DRV_AK4954_LRCLK_Sync(myAK4954Handle);

C

bool DRV_AK4954_LRCLK_Sync(const DRV_HANDLE handle);