radiodrv.h

ct952 source code use for Digital Frame Photo

//*********************************************************************************************************
//  @summary    Control the IIC SDA as HIGH
//  @param  None
//  @return None
//  @retval None
//  @description
//      This function be used to control SCL pin of IIC as HIGH state
//  @bug    None
//  @history 2007.04.18 first version   
//  @note     
//*********************************************************************************************************
void _RADIODRV_IIC_SDAHIGH(void);
//*********************************************************************************************************
//  @summary    Control the IIC SDA as LOW
//  @param  None
//  @return None
//  @retval None
//  @description
//      This function be used to control SCL pin of IIC as LOW state
//  @bug    None
//  @history 2007.04.18 first version   
//  @note      
//*********************************************************************************************************
void _RADIODRV_IIC_SDALOW(void);
//*********************************************************************************************************
//  @summary    Send the start signal of IIC at SCL/SDA pin
//  @param  None
//  @return None
//  @retval None
//  @description
//      This function be used to send start signal at SCL/SDA pin 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note      
//*********************************************************************************************************
void _RADIODRV_IIC_START(void);
//*********************************************************************************************************
//  @summary    Send the stop signal of IIC at SCL/SDA pin
//  @param  None
//  @return None
//  @retval None
//  @description
//      This function be used to send stop signal at SCL/SDA pin 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note     
//*********************************************************************************************************
void _RADIODRV_IIC_STOP(void);
//*********************************************************************************************************
//  @summary    Get the ACK signal from other device via SCL/SDA
//  @param  None
//  @return Make sure the ack signal
//  @retval TRUE    get the ack signal successfully
//  @retval FALSE   get the ack signal fail
//  @description
//      This function be used to get the ack signal from other device via SCL/SDA 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note  
//*********************************************************************************************************
BOOL _RADIODRV_IIC_GetACK(void);
//*********************************************************************************************************
//  @summary    To set the ACK signal to other device via SCL/SDA
//  @param  bACK    Send ack signal. if bACK as TRUE, the low signal of sda pin. otherwise, the high signal of sda pin
//  @return None
//  @retval None
//  @description
//      This function be used to set the ack signal to other device via SCL/SDA 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note    
//*********************************************************************************************************
void _RADIODRV_IIC_SETACK(BOOL bACK) ;
//*********************************************************************************************************
//  @summary    Write byte data to radio device via SCL/SDA pin
//  @param  bData   Desired write byte
//  @return Make sure the write byte status
//  @retval TRUE    Write byte successfully
//  @retval FALSE   Write byte fail
//  @description
//      This function be used to write registers of radio tuner to control radio device by IIC interface 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note  
//*********************************************************************************************************
BOOL _RADIODRV_WriteBYTE(BYTE bData);
//*********************************************************************************************************
//  @summary    Read byte data to radio device via SCL/SDA pin
//  @param  bData   Desired read byte
//  @return Make sure the read byte status
//  @retval TRUE    read byte successfully
//  @retval FALSE   read byte fail
//  @description
//      This function be used to read registers of radio tuner to control radio device by IIC interface 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note    
//*********************************************************************************************************
BYTE _RADIODRV_ReadBYTE(BYTE bACK);
//*********************************************************************************************************
//  @summary    Write register of si4703 radio tuner which size of word to control si4703 radio tuner
//  @param  bLastReg   desired writes last register address
//  @param  wRegArray  desired writes register data
//  @return Make sure that write registers status
//  @retval TRUE    write Si4703 radio tuner successfully
//  @retval FALSE   write Si4703 radio tuner fail
//  @description
//      This function be used to write registers of radio tuner which word of size to control si4703 radio tuner 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note    
//*********************************************************************************************************
BYTE _RADIODRV_WriteReg(BYTE bLastReg,WORD* wRegArray) ;
//*********************************************************************************************************
//  @summary    Read register of si4703 radio tuner which size of word to control si4703 radio tuner
//  @param  bLastReg   desired read last register address
//  @param  wRegArray  desired read register data
//  @return Make sure that read registers status
//  @retval TRUE    read Si4703 radio tuner successfully
//  @retval FALSE   read Si4703 radio tuner fail
//  @description
//      This function be used to read registers of radio tuner which word of size to control si4703 radio tuner 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note    
//*********************************************************************************************************
BYTE _RADIODRV_ReadReg(BYTE bLastReg, WORD* wRegArray);
//*********************************************************************************************************
//  @summary    Reset the radio tuner
//  @param  None
//  @return None
//  @retval None
//  @description
//      This function be used to reset the radio tuner for si4703 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note   
//*********************************************************************************************************
void RADIODRV_Reset(void); 
//*********************************************************************************************************
//  @summary    This function be used to power up radio tuner of si4703
//  @param  None
//  @return None
//  @retval None
//  @description
//      This function be used to power-up for radio tuner of si4703 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note  
//*********************************************************************************************************
void RADIODRV_PowerUp(void); 
//*********************************************************************************************************
//  @summary    This function be used to power down radio tuner of si4703
//  @param  None
//  @return None
//  @retval None
//  @description
//      This function be used to power-down for radio tuner of si4703 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note    
//*********************************************************************************************************
void RADIODRV_PowerDown(void); 
//*********************************************************************************************************
//  @summary    This function be used to convert frequency to channel
//  @param  wFreq   Desired frequency which needs to convert to channel
//  @return Number of channel 
//  @retval Number of channel which user desires to convert frequency
//  @description
//      This function be used to convert frequency to channel 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note     
//*********************************************************************************************************
WORD _RADIODRV_FreqToChan(WORD wFreq);
//*********************************************************************************************************
//  @summary    This function be used to convert channel to frequency
//  @param  wChan   Desired channel which needs to convert to frequency
//  @return Frequency 
//  @retval Frequency which user desires to convert channel
//  @description
//      This function be used to convert channel to frequency 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note    
//*********************************************************************************************************
WORD _RADIODRV_ChanToFreq(WORD wChan);
//*********************************************************************************************************
//  @summary    This function be used to tune radio station
//  @param  wRADIODRVfreq   desired tune frequency
//  @return status which be tuned frequency 
//  @retval TRUE    Tune frequency is sucessful
//  @retval FALSE   Tune frequency is un-sucessful
//  @description
//      This function be used to tune frequency 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note     
//*********************************************************************************************************
BYTE RADIODRV_tune(WORD wFMfreq);
//*********************************************************************************************************
//  @summary    This function be used to control volume of radio tuner 
//  @param  bVol   Desire to setting volume steps
//  @return None
//  @retval None
//  @description
//      This function be used to set volume of radio tuner 
//  @bug    None
//  @history 2007.04.18 first version   
//  @note   
//*********************************************************************************************************
void RADIODRV_SetVol (BYTE bVol);
//*********************************************************************************************************
//  @summary    This function be used to set mute for volume
//  @param  bmute   bmute as TRUE which disable mute,otherwise enalbe mute
//  @return None
//  @retval None
//  @description
//      This function be used to mute volume of radio  
//  @bug    None
//  @history 2007.04.18 first version   
//  @note     
//*********************************************************************************************************
void RADIODRV_SetMute (BYTE bMute);
//*********************************************************************************************************
//  @summary    This function be used to initiate radio tuner 
//  @param  None
//  @return Initial status of radio tuner
//  @retval None
//  @description
//      This function be used to initiate radio tuner
//  @bug    None
//  @history 2007.04.18 first version   
//  @note      
//*********************************************************************************************************
BYTE RADIODRV_Init(void); 
//*********************************************************************************************************
//  @summary    This function be used to get chip id of si4703
//  @param  None
//  @return Chip ID for si4703
//  @retval 0x04    SI4700
//  @retval 0x01    SI4701
//  @retval 0x02    SI4702
//  @retval 0x03    SI4703
//  @description
//      This function be used to get chip-id of the si-4703
//  @bug    None
//  @history 2007.04.18 first version   
//  @note     
//*********************************************************************************************************
BYTE _RADIODRV_GetChipID(void);
//*********************************************************************************************************
//  @summary    This function be used to get frequency
//  @param  None
//  @return Frequency of current station
//  @retval frequency value
//  @description
//      This function be used to get frequency of current station
//  @bug    None
//  @history 2007.04.18 first version   
//  @note      
//*********************************************************************************************************
WORD RADIODRV_GetFreq(void);
//*********************************************************************************************************
//  @summary    This function be used to get RSSI value
//  @param  None
//  @return Get RSSI of current station
//  @retval RSSI value
//  @description
//      This function be used to get RSSI(Received Signal Strength Indicator) value of current station
//  @bug    None
//  @history 2007.04.18 first version   
//  @note   
//*********************************************************************************************************
BYTE RADIODRV_GetRSSI(void);
//*********************************************************************************************************
//  @summary    This function be used to get volume value
//  @param  None
//  @return Get volume of current setting value 
//  @retval Volume value
//  @description
//      This function be used to get volume of current setting value
//  @bug    None
//  @history 2007.04.18 first version   
//  @note   
//*********************************************************************************************************
BYTE RADIODRV_GetVol(void);
//*********************************************************************************************************
//  @summary    This function be used to get mute status of volume
//  @param  None
//  @return Get mute status of volume
//  @retval TRUE    Enable Mute function
//  @retval FALSE   DISABLE Mute function