LPC1700CMSIS Standard Peripheral Firmware Library: I2S_Public_Functions

LPC1700CMSIS

previous page next page

I2S_Public_Functions
[I2S]


Functions

void I2S_Init (LPC_I2S_TypeDef *I2Sx)
 Initialize I2S
  • Turn on power and clock
  • Setup I2S pin select.

void I2S_DeInit (LPC_I2S_TypeDef *I2Sx)
 DeInitial both I2S transmit or receive.
void I2S_Config (LPC_I2S_TypeDef *I2Sx, uint8_t TRMode, I2S_CFG_Type *ConfigStruct)
 Configuration I2S, setting:
  • master/slave mode
  • wordwidth value
  • channel mode.

Status I2S_FreqConfig (LPC_I2S_TypeDef *I2Sx, uint32_t Freq, uint8_t TRMode)
 Set frequency for I2S.
void I2S_SetBitRate (LPC_I2S_TypeDef *I2Sx, uint8_t bitrate, uint8_t TRMode)
 I2S set bitrate.
void I2S_ModeConfig (LPC_I2S_TypeDef *I2Sx, I2S_MODEConf_Type *ModeConfig, uint8_t TRMode)
 Configuration operating mode for I2S.
void I2S_Send (LPC_I2S_TypeDef *I2Sx, uint32_t BufferData)
 I2S Send data.
uint32_t I2S_Receive (LPC_I2S_TypeDef *I2Sx)
 I2S Receive Data.
void I2S_Start (LPC_I2S_TypeDef *I2Sx)
 I2S Start: clear all STOP,RESET and MUTE bit, ready to operate.
void I2S_Pause (LPC_I2S_TypeDef *I2Sx, uint8_t TRMode)
 I2S Pause.
void I2S_Mute (LPC_I2S_TypeDef *I2Sx, uint8_t TRMode)
 I2S Mute.
void I2S_Stop (LPC_I2S_TypeDef *I2Sx, uint8_t TRMode)
 I2S Stop.
void I2S_DMAConfig (LPC_I2S_TypeDef *I2Sx, I2S_DMAConf_Type *DMAConfig, uint8_t TRMode)
 Configure DMA operation for I2S.
void I2S_DMACmd (LPC_I2S_TypeDef *I2Sx, uint8_t DMAIndex, uint8_t TRMode, FunctionalState NewState)
 Enable/Disable DMA operation for I2S.
void I2S_IRQConfig (LPC_I2S_TypeDef *I2Sx, uint8_t TRMode, uint8_t level, fnI2SCbs_Type *pfnI2SCbs)
 Configure IRQ for I2S.
void I2S_IRQCmd (LPC_I2S_TypeDef *I2Sx, uint8_t TRMode, FunctionalState NewState)
 Enable/Disable IRQ for I2S.
void I2S_IntHandler (void)
 Standard I2S interrupt handler, this function will check all interrupt status of I2S channels, then execute the call back function if they're already installed.
uint8_t I2S_GetLevel (LPC_I2S_TypeDef *I2Sx, uint8_t TRMode)
 Get I2S Buffer Level.

Function Documentation

void I2S_Config ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  TRMode,
I2S_CFG_Type *  ConfigStruct 
)

Configuration I2S, setting:

  • master/slave mode
  • wordwidth value
  • channel mode.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] TRMode,: transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
[in] ConfigStruct pointer to I2S_CFG_Type structure which will be initialized.
Returns:
none

Definition at line 151 of file lpc17xx_i2s.c.

void I2S_DeInit ( LPC_I2S_TypeDef *  I2Sx  ) 

DeInitial both I2S transmit or receive.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
Returns:
none

Definition at line 183 of file lpc17xx_i2s.c.

void I2S_DMACmd ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  DMAIndex,
uint8_t  TRMode,
FunctionalState  NewState 
)

Enable/Disable DMA operation for I2S.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] DMAIndex chose what DMA is used, should be:
  • I2S_DMA_1: DMA1
  • I2S_DMA_2: DMA2
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
[in] NewState is new state of DMA operation, should be:
  • ENABLE
  • DISABLE
Returns:
none

Definition at line 519 of file lpc17xx_i2s.c.

void I2S_DMAConfig ( LPC_I2S_TypeDef *  I2Sx,
I2S_DMAConf_Type *  DMAConfig,
uint8_t  TRMode 
)

Configure DMA operation for I2S.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] DMAConfig pointer to I2S_DMAConf_Type will be used to configure
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
Returns:
none

Definition at line 482 of file lpc17xx_i2s.c.

Status I2S_FreqConfig ( LPC_I2S_TypeDef *  I2Sx,
uint32_t  Freq,
uint8_t  TRMode 
)

Set frequency for I2S.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] Freq is the frequency for I2S will be set. It can range from 16-96 kHz(16, 22.05, 32, 44.1, 48, 96kHz)
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
Returns:
Status: ERROR or SUCCESS

Definition at line 325 of file lpc17xx_i2s.c.

uint8_t I2S_GetLevel ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  TRMode 
)

Get I2S Buffer Level.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] TRMode,: Transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
Returns:
current level of Transmit/Receive Buffer

Definition at line 198 of file lpc17xx_i2s.c.

void I2S_Init ( LPC_I2S_TypeDef *  I2Sx  ) 

Initialize I2S

  • Turn on power and clock
  • Setup I2S pin select.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
Returns:
none

Definition at line 130 of file lpc17xx_i2s.c.

void I2S_IntHandler ( void   ) 

Standard I2S interrupt handler, this function will check all interrupt status of I2S channels, then execute the call back function if they're already installed.

Parameters:
[in] None 
Returns:
None

Definition at line 614 of file lpc17xx_i2s.c.

void I2S_IRQCmd ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  TRMode,
FunctionalState  NewState 
)

Enable/Disable IRQ for I2S.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
[in] NewState is new state of DMA operation, should be:
  • ENABLE
  • DISABLE
Returns:
none

Definition at line 589 of file lpc17xx_i2s.c.

void I2S_IRQConfig ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  TRMode,
uint8_t  level,
fnI2SCbs_Type *  pfnI2SCbs 
)

Configure IRQ for I2S.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
[in] level,: is the FIFO level that triggers IRQ request
[in] pfnI2SCbs,: the pointer to call-back function handle this interrupt
Returns:
none

Definition at line 564 of file lpc17xx_i2s.c.

void I2S_ModeConfig ( LPC_I2S_TypeDef *  I2Sx,
I2S_MODEConf_Type *  ModeConfig,
uint8_t  TRMode 
)

Configuration operating mode for I2S.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] ModeConfig pointer to I2S_MODEConf_Type will be used to configure, should be:
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
Returns:
none

Definition at line 439 of file lpc17xx_i2s.c.

void I2S_Mute ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  TRMode 
)

I2S Mute.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
Returns:
none

Definition at line 278 of file lpc17xx_i2s.c.

void I2S_Pause ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  TRMode 
)

I2S Pause.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
Returns:
none

Definition at line 258 of file lpc17xx_i2s.c.

uint32_t I2S_Receive ( LPC_I2S_TypeDef *  I2Sx  ) 

I2S Receive Data.

Parameters:
[in] I2Sx pointer to LPC_I2S_TypeDef
Returns:
received value

Definition at line 244 of file lpc17xx_i2s.c.

void I2S_Send ( LPC_I2S_TypeDef *  I2Sx,
uint32_t  BufferData 
)

I2S Send data.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] BufferData pointer to uint32_t is the data will be send
Returns:
none

Definition at line 232 of file lpc17xx_i2s.c.

void I2S_SetBitRate ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  bitrate,
uint8_t  TRMode 
)

I2S set bitrate.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] bitrate value will be set
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
Returns:
none

Definition at line 414 of file lpc17xx_i2s.c.

void I2S_Start ( LPC_I2S_TypeDef *  I2Sx  ) 

I2S Start: clear all STOP,RESET and MUTE bit, ready to operate.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
Returns:
none

Definition at line 217 of file lpc17xx_i2s.c.

void I2S_Stop ( LPC_I2S_TypeDef *  I2Sx,
uint8_t  TRMode 
)

I2S Stop.

Parameters:
[in] I2Sx,: I2S peripheral selected, should be: I2S
[in] TRMode is transmit/receive mode, should be:
  • I2S_TX_MODE: transmit mode
  • I2S_RX_MODE: receive mode
Returns:
none

Definition at line 299 of file lpc17xx_i2s.c.

Generated on Mon Feb 8 10:01:45 2010 for LPC1700CMSIS Standard Peripheral Firmware Library by  doxygen 1.5.9
previous page start next page