RZ/A1H CMSIS-RTOS RTX BSP for GR-PEACH.

Dependents:   GR-PEACH_Azure_Speech ImageZoomInout_Sample ImageRotaion_Sample ImageScroll_Sample ... more

Fork of R_BSP by Daiki Kato

SSIF

The SSIF driver implements transmission and reception functionality which uses the SSIF in the RZ/A Series.

Hello World!

Import program

00001 #include "mbed.h"
00002 #include "R_BSP_Ssif.h"
00003 #include "sine_data_tbl.h"
00004 
00005 //I2S send only, The upper limit of write buffer is 8.
00006 R_BSP_Ssif ssif(P4_4, P4_5, P4_7, P4_6, 0x80, 8, 0);
00007 
00008 static void callback_ssif_write_end(void * p_data, int32_t result, void * p_app_data) {
00009     if (result < 0) {
00010         printf("ssif write callback error %d\n", result);
00011     }
00012 }
00013 
00014 int main() {
00015     rbsp_data_conf_t   ssif_write_end_conf = {&callback_ssif_write_end, NULL};
00016     ssif_channel_cfg_t ssif_cfg;
00017     int32_t            result;
00018 
00019     //I2S Master, 44.1kHz, 16bit, 2ch
00020     ssif_cfg.enabled                = true;
00021     ssif_cfg.int_level              = 0x78;
00022     ssif_cfg.slave_mode             = false;
00023     ssif_cfg.sample_freq            = 44100u;
00024     ssif_cfg.clk_select             = SSIF_CFG_CKS_AUDIO_X1;
00025     ssif_cfg.multi_ch               = SSIF_CFG_MULTI_CH_1;
00026     ssif_cfg.data_word              = SSIF_CFG_DATA_WORD_16;
00027     ssif_cfg.system_word            = SSIF_CFG_SYSTEM_WORD_32;
00028     ssif_cfg.bclk_pol               = SSIF_CFG_FALLING;
00029     ssif_cfg.ws_pol                 = SSIF_CFG_WS_LOW;
00030     ssif_cfg.padding_pol            = SSIF_CFG_PADDING_LOW;
00031     ssif_cfg.serial_alignment       = SSIF_CFG_DATA_FIRST;
00032     ssif_cfg.parallel_alignment     = SSIF_CFG_LEFT;
00033     ssif_cfg.ws_delay               = SSIF_CFG_DELAY;
00034     ssif_cfg.noise_cancel           = SSIF_CFG_DISABLE_NOISE_CANCEL;
00035     ssif_cfg.tdm_mode               = SSIF_CFG_DISABLE_TDM;
00036     ssif_cfg.romdec_direct.mode     = SSIF_CFG_DISABLE_ROMDEC_DIRECT;
00037     ssif_cfg.romdec_direct.p_cbfunc = NULL;
00038     result = ssif.ConfigChannel(&ssif_cfg);
00039     if (result < 0) {
00040         printf("ssif config error %d\n", result);
00041     }
00042 
00043     while (1) {
00044         //The upper limit of write buffer is 8.
00045         result = ssif.write((void *)sin_data_44100Hz_16bit_2ch, 
00046                             sizeof(sin_data_44100Hz_16bit_2ch), &ssif_write_end_conf);
00047         if (result < 0) {
00048             printf("ssif write api error %d\n", result);
00049         }
00050     }
00051 }

API

Import library

Public Member Functions

R_BSP_Ssif (PinName sck, PinName ws, PinName tx, PinName rx, uint8_t int_level=0x80, int32_t max_write_num=16, int32_t max_read_num=16)
Constructor.
virtual ~R_BSP_Ssif ()
Destructor.
int32_t GetSsifChNo (void)
Get a value of SSIF channel number.
bool ConfigChannel (const ssif_channel_cfg_t *const p_ch_cfg)
Save configuration to the SSIF driver.
bool GetStatus (uint32_t *const p_status)
Get a value of SSISR register.
int32_t write (void *const p_data, uint32_t data_size, const rbsp_data_conf_t *const p_data_conf=NULL)
Write count bytes to the file associated.
int32_t read (void *const p_data, uint32_t data_size, const rbsp_data_conf_t *const p_data_conf=NULL)
Read count bytes to the file associated.

Protected Member Functions

void write_init (void *handle, void *p_func_a, int32_t max_buff_num=16)
Write init.
void read_init (void *handle, void *p_func_a, int32_t max_buff_num=16)
Read init.

Interface

See the Pinout page for more details


SCUX

The SCUX module consists of a sampling rate converter, a digital volume unit, and a mixer.
The SCUX driver can perform asynchronous and synchronous sampling rate conversions using the sampling rate converter. The SCUX driver uses the DMA transfer mode to input and output audio data.

Hello World!

Import program

00001 #include "mbed.h"
00002 #include "R_BSP_Scux.h"
00003 #include "USBHostMSD.h"
00004 
00005 R_BSP_Scux scux(SCUX_CH_0);
00006 
00007 #define WRITE_SAMPLE_NUM (128)
00008 #define READ_SAMPLE_NUM  (2048)
00009 
00010 const short sin_data[WRITE_SAMPLE_NUM] = {
00011  0x0000,0x0000,0x0C8C,0x0C8C,0x18F9,0x18F9,0x2528,0x2528
00012 ,0x30FB,0x30FB,0x3C56,0x3C56,0x471C,0x471C,0x5133,0x5133
00013 ,0x5A82,0x5A82,0x62F1,0x62F1,0x6A6D,0x6A6D,0x70E2,0x70E2
00014 ,0x7641,0x7641,0x7A7C,0x7A7C,0x7D89,0x7D89,0x7F61,0x7F61
00015 ,0x7FFF,0x7FFF,0x7F61,0x7F61,0x7D89,0x7D89,0x7A7C,0x7A7C
00016 ,0x7641,0x7641,0x70E2,0x70E2,0x6A6D,0x6A6D,0x62F1,0x62F1
00017 ,0x5A82,0x5A82,0x5133,0x5133,0x471C,0x471C,0x3C56,0x3C56
00018 ,0x30FB,0x30FB,0x2528,0x2528,0x18F9,0x18F9,0x0C8C,0x0C8C
00019 ,0x0000,0x0000,0xF374,0xF374,0xE707,0xE707,0xDAD8,0xDAD8
00020 ,0xCF05,0xCF05,0xC3AA,0xC3AA,0xB8E4,0xB8E4,0xAECD,0xAECD
00021 ,0xA57E,0xA57E,0x9D0F,0x9D0F,0x9593,0x9593,0x8F1E,0x8F1E
00022 ,0x89BF,0x89BF,0x8584,0x8584,0x8277,0x8277,0x809F,0x809F
00023 ,0x8001,0x8001,0x809F,0x809F,0x8277,0x8277,0x8584,0x8584
00024 ,0x89BF,0x89BF,0x8F1E,0x8F1E,0x9593,0x9593,0x9D0F,0x9D0F
00025 ,0xA57E,0xA57E,0xAECD,0xAECD,0xB8E4,0xB8E4,0xC3AA,0xC3AA
00026 ,0xCF05,0xCF05,0xDAD8,0xDAD8,0xE707,0xE707,0xF374,0xF374
00027 };
00028 
00029 #if defined(__ICCARM__)
00030 #pragma data_alignment=4
00031 short write_buff[WRITE_SAMPLE_NUM]@ ".mirrorram";
00032 #pragma data_alignment=4
00033 short read_buff[READ_SAMPLE_NUM]@ ".mirrorram";
00034 #else
00035 short write_buff[WRITE_SAMPLE_NUM] __attribute((section("NC_BSS"),aligned(4)));
00036 short read_buff[READ_SAMPLE_NUM] __attribute((section("NC_BSS"),aligned(4)));
00037 #endif
00038 
00039 void scux_setup(void);
00040 void write_task(void const*);
00041 void file_output_to_usb(void);
00042 
00043 int main(void) {
00044     // set up SRC parameters.
00045     scux_setup();
00046 
00047     printf("Sampling rate conversion Start.\n");
00048     // start accepting transmit/receive requests.
00049     scux.TransStart();
00050 
00051     // create a new thread to write to SCUX.
00052     Thread writeTask(write_task, NULL, osPriorityNormal, 1024 * 4);
00053 
00054     // receive request to the SCUX driver.
00055     scux.read(read_buff, sizeof(read_buff));
00056     printf("Sampling rate conversion End.\n");
00057 
00058     // output binary file to USB port 0.
00059     file_output_to_usb();
00060 }
00061 
00062 void scux_setup(void) {
00063     scux_src_usr_cfg_t src_cfg;
00064 
00065     src_cfg.src_enable           = true;
00066     src_cfg.word_len             = SCUX_DATA_LEN_16;
00067     src_cfg.mode_sync            = true;
00068     src_cfg.input_rate           = SAMPLING_RATE_48000HZ;
00069     src_cfg.output_rate          = SAMPLING_RATE_96000HZ;
00070     src_cfg.select_in_data_ch[0] = SELECT_IN_DATA_CH_0;
00071     src_cfg.select_in_data_ch[1] = SELECT_IN_DATA_CH_1;
00072 
00073     scux.SetSrcCfg(&src_cfg);
00074 }
00075 
00076 void scux_flush_callback(int scux_ch) {
00077     // do nothing
00078 }
00079 
00080 void write_task(void const*) {
00081     memcpy(write_buff, sin_data, sizeof(write_buff));
00082     // send request to the SCUX driver.
00083     scux.write(write_buff, sizeof(write_buff));
00084 
00085     // stop the acceptance of transmit/receive requests.
00086     scux.FlushStop(&scux_flush_callback);
00087 }
00088 
00089 void file_output_to_usb(void) {
00090     FILE * fp = NULL;
00091     int i;
00092 
00093     USBHostMSD msd("usb");
00094 
00095     // try to connect a MSD device
00096     for(i = 0; i < 10; i++) {
00097         if (msd.connect()) {
00098             break;
00099         }
00100         wait(0.5);
00101     }
00102 
00103     if (msd.connected()) {
00104         fp = fopen("/usb/scux_input.dat", "rb");
00105         if (fp == NULL) {
00106             fp = fopen("/usb/scux_input.dat", "wb");
00107             if (fp != NULL) {
00108                 fwrite(write_buff, sizeof(short), WRITE_SAMPLE_NUM, fp);
00109                 fclose(fp);
00110                 printf("Output binary file(Input data) to USB.\n");
00111             } else {
00112                 printf("Failed to output binary file(Input data).\n");
00113             }
00114         } else {
00115             printf("Binary file(Input data) exists.\n");
00116             fclose(fp);
00117         }
00118 
00119         fp = fopen("/usb/scux_output.dat", "rb");
00120         if (fp == NULL) {
00121             fp = fopen("/usb/scux_output.dat", "wb");
00122             if (fp != NULL) {
00123                 fwrite(read_buff, sizeof(short), READ_SAMPLE_NUM, fp);
00124                 fclose(fp);
00125                 printf("Output binary file(Output data) to USB.\n");
00126             } else {
00127                 printf("Failed to output binary file(Output data).\n");
00128             }
00129         } else {
00130             printf("Binary file(Output data) exists.\n");
00131             fclose(fp);
00132         }
00133     } else {
00134         printf("Failed to connect to the USB device.\n");
00135     }
00136 } 

API

Import library

Public Member Functions

R_BSP_Scux ( scux_ch_num_t channel, uint8_t int_level=0x80, int32_t max_write_num=16, int32_t max_read_num=16)
Constructor: Initializes and opens the channel designated by the SCUX driver.
virtual ~R_BSP_Scux (void)
Destructor: Closes the channel designated by the SCUX driver and exits.
bool TransStart (void)
Sets up the SCUX HW and starts operation, then starts accepting write/read requests.
bool FlushStop (void(*const callback)(int32_t))
Stops accepting write/read requests, flushes out all data in the SCUX that is requested for transfer, then stops the HW operation.
bool ClearStop (void)
Discards all data in the SCUX that is requested for transfer before stopping the hardware operation and stops accepting write/read requests.
bool SetSrcCfg (const scux_src_usr_cfg_t *const p_src_param)
Sets up SRC parameters.
bool GetWriteStat (uint32_t *const p_write_stat)
Obtains the state information of the write request.
bool GetReadStat (uint32_t *const p_read_stat)
Obtains the state information of the read request.
int32_t write (void *const p_data, uint32_t data_size, const rbsp_data_conf_t *const p_data_conf=NULL)
Write count bytes to the file associated.
int32_t read (void *const p_data, uint32_t data_size, const rbsp_data_conf_t *const p_data_conf=NULL)
Read count bytes to the file associated.

Protected Member Functions

void write_init (void *handle, void *p_func_a, int32_t max_buff_num=16)
Write init.
void read_init (void *handle, void *p_func_a, int32_t max_buff_num=16)
Read init.

Write request state transition diagram

/media/uploads/dkato/scux_write_state_transition.png

Read request state transition diagram

/media/uploads/dkato/scux_read_state_transition.png

Committer:
dkato
Date:
Wed Dec 16 06:33:17 2015 +0000
Revision:
7:30ebba78fff0
Parent:
0:702bf7b2b7d8
Child:
8:cbb9d60c8748
Standardization of processing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dkato 0:702bf7b2b7d8 1 /*******************************************************************************
dkato 0:702bf7b2b7d8 2 * DISCLAIMER
dkato 0:702bf7b2b7d8 3 * This software is supplied by Renesas Electronics Corporation and is only
dkato 0:702bf7b2b7d8 4 * intended for use with Renesas products. No other uses are authorized. This
dkato 0:702bf7b2b7d8 5 * software is owned by Renesas Electronics Corporation and is protected under
dkato 0:702bf7b2b7d8 6 * all applicable laws, including copyright laws.
dkato 0:702bf7b2b7d8 7 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
dkato 0:702bf7b2b7d8 8 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
dkato 0:702bf7b2b7d8 9 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
dkato 0:702bf7b2b7d8 10 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
dkato 0:702bf7b2b7d8 11 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
dkato 0:702bf7b2b7d8 12 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
dkato 0:702bf7b2b7d8 13 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
dkato 0:702bf7b2b7d8 14 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
dkato 0:702bf7b2b7d8 15 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
dkato 0:702bf7b2b7d8 16 * Renesas reserves the right, without notice, to make changes to this software
dkato 0:702bf7b2b7d8 17 * and to discontinue the availability of this software. By using this software,
dkato 0:702bf7b2b7d8 18 * you agree to the additional terms and conditions found by accessing the
dkato 0:702bf7b2b7d8 19 * following link:
dkato 0:702bf7b2b7d8 20 * http://www.renesas.com/disclaimer
dkato 0:702bf7b2b7d8 21 * Copyright (C) 2013-2014 Renesas Electronics Corporation. All rights reserved.
dkato 0:702bf7b2b7d8 22 *******************************************************************************/
dkato 0:702bf7b2b7d8 23
dkato 0:702bf7b2b7d8 24 /******************************************************************************
dkato 0:702bf7b2b7d8 25 * File Name : ssif_if.h
dkato 0:702bf7b2b7d8 26 * $Rev: 1032 $
dkato 0:702bf7b2b7d8 27 * $Date:: 2014-08-06 09:04:50 +0900#$
dkato 0:702bf7b2b7d8 28 * Description : SSIF Driver API header
dkato 0:702bf7b2b7d8 29 ******************************************************************************/
dkato 0:702bf7b2b7d8 30
dkato 0:702bf7b2b7d8 31 #ifndef SSIF_IF_H
dkato 0:702bf7b2b7d8 32 #define SSIF_IF_H
dkato 0:702bf7b2b7d8 33
dkato 0:702bf7b2b7d8 34 /******************************************************************************
dkato 0:702bf7b2b7d8 35 Includes <System Includes> , "Project Includes"
dkato 0:702bf7b2b7d8 36 ******************************************************************************/
dkato 0:702bf7b2b7d8 37
dkato 0:702bf7b2b7d8 38 #include "cmsis_os.h"
dkato 0:702bf7b2b7d8 39
dkato 0:702bf7b2b7d8 40 #include "r_typedefs.h"
dkato 0:702bf7b2b7d8 41 #include "r_errno.h"
dkato 0:702bf7b2b7d8 42 #if(1) /* mbed */
dkato 0:702bf7b2b7d8 43 #include "misratypes.h"
dkato 0:702bf7b2b7d8 44 #include "aioif.h"
dkato 7:30ebba78fff0 45 #include "R_BSP_mbed_fns.h"
dkato 0:702bf7b2b7d8 46 #include "R_BSP_SsifDef.h"
dkato 0:702bf7b2b7d8 47 #else
dkato 0:702bf7b2b7d8 48 #include "ioif_public.h"
dkato 0:702bf7b2b7d8 49 #endif
dkato 0:702bf7b2b7d8 50
dkato 0:702bf7b2b7d8 51 #ifdef __cplusplus
dkato 0:702bf7b2b7d8 52 extern "C" {
dkato 0:702bf7b2b7d8 53 #endif
dkato 0:702bf7b2b7d8 54
dkato 0:702bf7b2b7d8 55 #if(1) /* mbed */
dkato 0:702bf7b2b7d8 56 /******************************************************************************
dkato 0:702bf7b2b7d8 57 Function Prototypes
dkato 0:702bf7b2b7d8 58 *****************************************************************************/
dkato 0:702bf7b2b7d8 59
dkato 7:30ebba78fff0 60 extern RBSP_MBED_FNS* R_SSIF_MakeCbTbl_mbed(void);
dkato 0:702bf7b2b7d8 61 #else
dkato 0:702bf7b2b7d8 62 /******************************************************************************
dkato 0:702bf7b2b7d8 63 Defines
dkato 0:702bf7b2b7d8 64 *****************************************************************************/
dkato 0:702bf7b2b7d8 65
dkato 0:702bf7b2b7d8 66 /******************************************************************************
dkato 0:702bf7b2b7d8 67 Constant Macros
dkato 0:702bf7b2b7d8 68 *****************************************************************************/
dkato 0:702bf7b2b7d8 69 #define SSIF_NUM_CHANS (6u) /**< Number of SSIF channels */
dkato 0:702bf7b2b7d8 70
dkato 0:702bf7b2b7d8 71 #define SSIF_CFG_DISABLE_ROMDEC_DIRECT (0x0u) /* Disable SSIRDR->STRMDIN0 route */
dkato 0:702bf7b2b7d8 72 #define SSIF_CFG_ENABLE_ROMDEC_DIRECT (0xDEC0DEC1u) /* Enable SSIRDR->STRMDIN0 route */
dkato 0:702bf7b2b7d8 73
dkato 0:702bf7b2b7d8 74 /******************************************************************************
dkato 0:702bf7b2b7d8 75 Function Macros
dkato 0:702bf7b2b7d8 76 *****************************************************************************/
dkato 0:702bf7b2b7d8 77
dkato 0:702bf7b2b7d8 78 /******************************************************************************
dkato 0:702bf7b2b7d8 79 Enumerated Types
dkato 0:702bf7b2b7d8 80 *****************************************************************************/
dkato 0:702bf7b2b7d8 81
dkato 0:702bf7b2b7d8 82 /** SSICR:CKS(Clock source for oversampling) */
dkato 0:702bf7b2b7d8 83 typedef enum
dkato 0:702bf7b2b7d8 84 {
dkato 0:702bf7b2b7d8 85 SSIF_CFG_CKS_AUDIO_X1 = 0, /**< select AUDIO_X1 */
dkato 0:702bf7b2b7d8 86 SSIF_CFG_CKS_AUDIO_CLK = 1 /**< select AUIDIO_CLK */
dkato 0:702bf7b2b7d8 87 } ssif_chcfg_cks_t;
dkato 0:702bf7b2b7d8 88
dkato 0:702bf7b2b7d8 89 /** SSICR:CHNL(Audio channels per system word) */
dkato 0:702bf7b2b7d8 90 typedef enum
dkato 0:702bf7b2b7d8 91 {
dkato 0:702bf7b2b7d8 92 SSIF_CFG_MULTI_CH_1 = 0, /**< 1ch within systemword (on tdm=0) */
dkato 0:702bf7b2b7d8 93 SSIF_CFG_MULTI_CH_2 = 1, /**< 2ch within systemword (on tdm=0) */
dkato 0:702bf7b2b7d8 94 SSIF_CFG_MULTI_CH_3 = 2, /**< 3ch within systemword (on tdm=0) */
dkato 0:702bf7b2b7d8 95 SSIF_CFG_MULTI_CH_4 = 3 /**< 4ch within systemword (on tdm=0) */
dkato 0:702bf7b2b7d8 96 } ssif_chcfg_multi_ch_t;
dkato 0:702bf7b2b7d8 97
dkato 0:702bf7b2b7d8 98 /** SSICR:DWL(Data word length) */
dkato 0:702bf7b2b7d8 99 typedef enum
dkato 0:702bf7b2b7d8 100 {
dkato 0:702bf7b2b7d8 101 SSIF_CFG_DATA_WORD_8 = 0, /**< Data word length 8 */
dkato 0:702bf7b2b7d8 102 SSIF_CFG_DATA_WORD_16 = 1, /**< Data word length 16 */
dkato 0:702bf7b2b7d8 103 SSIF_CFG_DATA_WORD_18 = 2, /**< Data word length 18 */
dkato 0:702bf7b2b7d8 104 SSIF_CFG_DATA_WORD_20 = 3, /**< Data word length 20 */
dkato 0:702bf7b2b7d8 105 SSIF_CFG_DATA_WORD_22 = 4, /**< Data word length 22 */
dkato 0:702bf7b2b7d8 106 SSIF_CFG_DATA_WORD_24 = 5, /**< Data word length 24 */
dkato 0:702bf7b2b7d8 107 SSIF_CFG_DATA_WORD_32 = 6 /**< Data word length 32 */
dkato 0:702bf7b2b7d8 108 } ssif_chcfg_data_word_t;
dkato 0:702bf7b2b7d8 109
dkato 0:702bf7b2b7d8 110 /** SSICR:SWL(System word length) */
dkato 0:702bf7b2b7d8 111 typedef enum
dkato 0:702bf7b2b7d8 112 {
dkato 0:702bf7b2b7d8 113 SSIF_CFG_SYSTEM_WORD_8 = 0, /**< System word length 8 */
dkato 0:702bf7b2b7d8 114 SSIF_CFG_SYSTEM_WORD_16 = 1, /**< System word length 16 */
dkato 0:702bf7b2b7d8 115 SSIF_CFG_SYSTEM_WORD_24 = 2, /**< System word length 24 */
dkato 0:702bf7b2b7d8 116 SSIF_CFG_SYSTEM_WORD_32 = 3, /**< System word length 32 */
dkato 0:702bf7b2b7d8 117 SSIF_CFG_SYSTEM_WORD_48 = 4, /**< System word length 48 */
dkato 0:702bf7b2b7d8 118 SSIF_CFG_SYSTEM_WORD_64 = 5, /**< System word length 64 */
dkato 0:702bf7b2b7d8 119 SSIF_CFG_SYSTEM_WORD_128 = 6, /**< System word length 128 */
dkato 0:702bf7b2b7d8 120 SSIF_CFG_SYSTEM_WORD_256 = 7 /**< System word length 256 */
dkato 0:702bf7b2b7d8 121 } ssif_chcfg_system_word_t;
dkato 0:702bf7b2b7d8 122
dkato 0:702bf7b2b7d8 123 /** SSICR:SCKP(Clock polarity) */
dkato 0:702bf7b2b7d8 124 typedef enum
dkato 0:702bf7b2b7d8 125 {
dkato 0:702bf7b2b7d8 126 SSIF_CFG_FALLING = 0, /**< Falling edge */
dkato 0:702bf7b2b7d8 127 SSIF_CFG_RISING = 1 /**< Rising edge */
dkato 0:702bf7b2b7d8 128 } ssif_chcfg_clock_pol_t;
dkato 0:702bf7b2b7d8 129
dkato 0:702bf7b2b7d8 130 /** SSICR:SWSP(Word select polarity) */
dkato 0:702bf7b2b7d8 131 typedef enum
dkato 0:702bf7b2b7d8 132 {
dkato 0:702bf7b2b7d8 133 SSIF_CFG_WS_LOW = 0, /**< Low for ther 1st channel(not TDM) */
dkato 0:702bf7b2b7d8 134 SSIF_CFG_WS_HIGH = 1 /**< High for the 1st channel(not TDM) */
dkato 0:702bf7b2b7d8 135 } ssif_chcfg_ws_pol_t;
dkato 0:702bf7b2b7d8 136
dkato 0:702bf7b2b7d8 137 /** SSICR:SPDP(Serial padding polarity) */
dkato 0:702bf7b2b7d8 138 typedef enum
dkato 0:702bf7b2b7d8 139 {
dkato 0:702bf7b2b7d8 140 SSIF_CFG_PADDING_LOW = 0, /**< Padding bits are low */
dkato 0:702bf7b2b7d8 141 SSIF_CFG_PADDING_HIGH = 1 /**< Padding bits are high */
dkato 0:702bf7b2b7d8 142 } ssif_chcfg_padding_pol_t;
dkato 0:702bf7b2b7d8 143
dkato 0:702bf7b2b7d8 144 /** SSICR:SDTA(Serial data alignment) */
dkato 0:702bf7b2b7d8 145 typedef enum
dkato 0:702bf7b2b7d8 146 {
dkato 0:702bf7b2b7d8 147 SSIF_CFG_DATA_FIRST = 0, /**< Data first */
dkato 0:702bf7b2b7d8 148 SSIF_CFG_PADDING_FIRST = 1 /**< Padding bits first */
dkato 0:702bf7b2b7d8 149 } ssif_chcfg_serial_alignment_t;
dkato 0:702bf7b2b7d8 150
dkato 0:702bf7b2b7d8 151 /** SSICR:PDTA(Parallel data alignment) */
dkato 0:702bf7b2b7d8 152 typedef enum
dkato 0:702bf7b2b7d8 153 {
dkato 0:702bf7b2b7d8 154 SSIF_CFG_LEFT = 0, /**< Left aligned */
dkato 0:702bf7b2b7d8 155 SSIF_CFG_RIGHT = 1 /**< Right aligned */
dkato 0:702bf7b2b7d8 156 } ssif_chcfg_parallel_alignment_t;
dkato 0:702bf7b2b7d8 157
dkato 0:702bf7b2b7d8 158 /** SSICR:DEL(Serial data delay) */
dkato 0:702bf7b2b7d8 159 typedef enum
dkato 0:702bf7b2b7d8 160 {
dkato 0:702bf7b2b7d8 161 SSIF_CFG_DELAY = 0, /**< 1 clock delay */
dkato 0:702bf7b2b7d8 162 SSIF_CFG_NO_DELAY = 1 /**< No delay */
dkato 0:702bf7b2b7d8 163 } ssif_chcfg_ws_delay_t;
dkato 0:702bf7b2b7d8 164
dkato 0:702bf7b2b7d8 165 /** SSICR:CKDV(Serial oversampling clock division ratio) */
dkato 0:702bf7b2b7d8 166 typedef enum
dkato 0:702bf7b2b7d8 167 {
dkato 0:702bf7b2b7d8 168 SSIF_CFG_CKDV_BITS_1 = 0,
dkato 0:702bf7b2b7d8 169 SSIF_CFG_CKDV_BITS_2 = 1,
dkato 0:702bf7b2b7d8 170 SSIF_CFG_CKDV_BITS_4 = 2,
dkato 0:702bf7b2b7d8 171 SSIF_CFG_CKDV_BITS_8 = 3,
dkato 0:702bf7b2b7d8 172 SSIF_CFG_CKDV_BITS_16 = 4,
dkato 0:702bf7b2b7d8 173 SSIF_CFG_CKDV_BITS_32 = 5,
dkato 0:702bf7b2b7d8 174 SSIF_CFG_CKDV_BITS_64 = 6,
dkato 0:702bf7b2b7d8 175 SSIF_CFG_CKDV_BITS_128 = 7,
dkato 0:702bf7b2b7d8 176 SSIF_CFG_CKDV_BITS_6 = 8,
dkato 0:702bf7b2b7d8 177 SSIF_CFG_CKDV_BITS_12 = 9,
dkato 0:702bf7b2b7d8 178 SSIF_CFG_CKDV_BITS_24 = 10,
dkato 0:702bf7b2b7d8 179 SSIF_CFG_CKDV_BITS_48 = 11,
dkato 0:702bf7b2b7d8 180 SSIF_CFG_CKDV_BITS_96 = 12
dkato 0:702bf7b2b7d8 181 } ssif_chcfg_ckdv_t;
dkato 0:702bf7b2b7d8 182
dkato 0:702bf7b2b7d8 183
dkato 0:702bf7b2b7d8 184 /** SNCR:SSIxNL(Serial sound interface channel x noise canceler enable) */
dkato 0:702bf7b2b7d8 185 typedef enum
dkato 0:702bf7b2b7d8 186 {
dkato 0:702bf7b2b7d8 187 SSIF_CFG_DISABLE_NOISE_CANCEL = 0, /**< Not use noise cancel function */
dkato 0:702bf7b2b7d8 188 SSIF_CFG_ENABLE_NOISE_CANCEL = 1 /**< Use noise cancel function */
dkato 0:702bf7b2b7d8 189 } ssif_chcfg_noise_cancel_t;
dkato 0:702bf7b2b7d8 190
dkato 0:702bf7b2b7d8 191
dkato 0:702bf7b2b7d8 192 /** SSITDMR:TDM(TDM mode) */
dkato 0:702bf7b2b7d8 193 typedef enum
dkato 0:702bf7b2b7d8 194 {
dkato 0:702bf7b2b7d8 195 SSIF_CFG_DISABLE_TDM = 0, /**< not TDM mode */
dkato 0:702bf7b2b7d8 196 SSIF_CFG_ENABLE_TDM = 1 /**< set TDM mode */
dkato 0:702bf7b2b7d8 197 } ssif_chcfg_tdm_t;
dkato 0:702bf7b2b7d8 198
dkato 0:702bf7b2b7d8 199 /******************************************************************************
dkato 0:702bf7b2b7d8 200 Structures
dkato 0:702bf7b2b7d8 201 *****************************************************************************/
dkato 0:702bf7b2b7d8 202
dkato 0:702bf7b2b7d8 203 typedef struct
dkato 0:702bf7b2b7d8 204 {
dkato 0:702bf7b2b7d8 205 uint32_t mode; /* Enable/Disable SSIRDR->STRMDIN0 route */
dkato 0:702bf7b2b7d8 206 void (*p_cbfunc)(void); /* SSIF error callback function */
dkato 0:702bf7b2b7d8 207 } ssif_chcfg_romdec_t;
dkato 0:702bf7b2b7d8 208
dkato 0:702bf7b2b7d8 209 /**< This structure contains the configuration settings */
dkato 0:702bf7b2b7d8 210 typedef struct
dkato 0:702bf7b2b7d8 211 {
dkato 0:702bf7b2b7d8 212 bool_t enabled; /* The enable flag for the channel */
dkato 0:702bf7b2b7d8 213 uint8_t int_level; /* Interrupt priority for the channel */
dkato 0:702bf7b2b7d8 214 bool_t slave_mode; /* Mode of operation */
dkato 0:702bf7b2b7d8 215 uint32_t sample_freq; /* Audio Sampling frequency(Hz) */
dkato 0:702bf7b2b7d8 216 ssif_chcfg_cks_t clk_select; /* SSICR-CKS : Audio clock select */
dkato 0:702bf7b2b7d8 217 ssif_chcfg_multi_ch_t multi_ch; /* SSICR-CHNL: Audio channels per system word */
dkato 0:702bf7b2b7d8 218 ssif_chcfg_data_word_t data_word; /* SSICR-DWL : Data word length */
dkato 0:702bf7b2b7d8 219 ssif_chcfg_system_word_t system_word; /* SSICR-SWL : System word length */
dkato 0:702bf7b2b7d8 220 ssif_chcfg_clock_pol_t bclk_pol; /* SSICR-SCKP: Bit Clock polarity */
dkato 0:702bf7b2b7d8 221 ssif_chcfg_ws_pol_t ws_pol; /* SSICR-SWSP: Word Clock polarity */
dkato 0:702bf7b2b7d8 222 ssif_chcfg_padding_pol_t padding_pol; /* SSICR-SPDP: Padding polarity */
dkato 0:702bf7b2b7d8 223 ssif_chcfg_serial_alignment_t serial_alignment; /* SSICR-SDTA: Serial data alignment */
dkato 0:702bf7b2b7d8 224 ssif_chcfg_parallel_alignment_t parallel_alignment; /* SSICR-PDTA: Parallel data alignment */
dkato 0:702bf7b2b7d8 225 ssif_chcfg_ws_delay_t ws_delay; /* SSICR-DEL : Serial clock delay */
dkato 0:702bf7b2b7d8 226 ssif_chcfg_noise_cancel_t noise_cancel; /* GPIO-SNCR : Noise cancel */
dkato 0:702bf7b2b7d8 227 ssif_chcfg_tdm_t tdm_mode; /* SSITDMR-TDM: TDM mode */
dkato 0:702bf7b2b7d8 228 ssif_chcfg_romdec_t romdec_direct; /* DMA : SSIRDR->STRMDIN0 route settings */
dkato 0:702bf7b2b7d8 229 } ssif_channel_cfg_t;
dkato 0:702bf7b2b7d8 230
dkato 0:702bf7b2b7d8 231 /******************************************************************************
dkato 0:702bf7b2b7d8 232 IOCTLS
dkato 0:702bf7b2b7d8 233 *****************************************************************************/
dkato 0:702bf7b2b7d8 234
dkato 0:702bf7b2b7d8 235 #define SSIF_CONFIG_CHANNEL (7)
dkato 0:702bf7b2b7d8 236 #define SSIF_GET_STATUS (13)
dkato 0:702bf7b2b7d8 237
dkato 0:702bf7b2b7d8 238
dkato 0:702bf7b2b7d8 239 /******************************************************************************
dkato 0:702bf7b2b7d8 240 External Data
dkato 0:702bf7b2b7d8 241 *****************************************************************************/
dkato 0:702bf7b2b7d8 242
dkato 0:702bf7b2b7d8 243
dkato 0:702bf7b2b7d8 244 /******************************************************************************
dkato 0:702bf7b2b7d8 245 Function Prototypes
dkato 0:702bf7b2b7d8 246 *****************************************************************************/
dkato 0:702bf7b2b7d8 247 /**
dkato 0:702bf7b2b7d8 248 * @ingroup API
dkato 0:702bf7b2b7d8 249 *
dkato 0:702bf7b2b7d8 250 * This function returns a pointer to the function table of the SSIF driver.
dkato 0:702bf7b2b7d8 251 * This is intended to be used as a parameter in the ioif_start_device function.
dkato 0:702bf7b2b7d8 252 *
dkato 0:702bf7b2b7d8 253 * @retval IOIF_DRV_API* - Pointer to the table of functions supported by the
dkato 0:702bf7b2b7d8 254 * driver.
dkato 0:702bf7b2b7d8 255 *
dkato 0:702bf7b2b7d8 256 */
dkato 0:702bf7b2b7d8 257 extern IOIF_DRV_API *R_SSIF_MakeCbTbl(void);
dkato 0:702bf7b2b7d8 258 #endif
dkato 0:702bf7b2b7d8 259
dkato 0:702bf7b2b7d8 260 extern int_t R_SSIF_SWLtoLen(const ssif_chcfg_system_word_t ssicr_swl);
dkato 0:702bf7b2b7d8 261
dkato 0:702bf7b2b7d8 262 extern int_t R_SSIF_Userdef_InitPinMux(const uint32_t ssif_ch);
dkato 0:702bf7b2b7d8 263 extern int_t R_SSIF_Userdef_SetClockDiv(const ssif_channel_cfg_t* const p_ch_cfg, ssif_chcfg_ckdv_t* const p_clk_div);
dkato 0:702bf7b2b7d8 264
dkato 0:702bf7b2b7d8 265 extern uint16_t R_SSIF_GetVersion(void);
dkato 0:702bf7b2b7d8 266
dkato 0:702bf7b2b7d8 267 #ifdef __cplusplus
dkato 0:702bf7b2b7d8 268 }
dkato 0:702bf7b2b7d8 269 #endif
dkato 0:702bf7b2b7d8 270
dkato 0:702bf7b2b7d8 271 #endif /* SSIF_IF_H */
dkato 0:702bf7b2b7d8 272 /*EOF*/
dkato 0:702bf7b2b7d8 273