R_BSP_ScuxDef.h

00001 /*******************************************************************************
00002 * DISCLAIMER
00003 * This software is supplied by Renesas Electronics Corporation and is only
00004 * intended for use with Renesas products. No other uses are authorized. This
00005 * software is owned by Renesas Electronics Corporation and is protected under
00006 * all applicable laws, including copyright laws.
00007 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
00008 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
00009 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
00010 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
00011 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
00012 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
00013 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
00014 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
00015 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00016 * Renesas reserves the right, without notice, to make changes to this software
00017 * and to discontinue the availability of this software. By using this software,
00018 * you agree to the additional terms and conditions found by accessing the
00019 * following link:
00020 * http://www.renesas.com/disclaimer
00021 * Copyright (C) 2015 Renesas Electronics Corporation. All rights reserved.
00022 *******************************************************************************/
00023 /**************************************************************************//**
00024 * @file          R_BSP_ScuxDef.h
00025 * @brief         SCUX defines
00026 ******************************************************************************/
00027 
00028 #ifndef R_BSP_SCUXDEF_H
00029 #define R_BSP_SCUXDEF_H
00030 
00031 /******************************************************************************
00032 Includes <System Includes> , "Project Includes"
00033 ******************************************************************************/
00034 
00035 #ifdef __cplusplus
00036 extern "C"
00037 {
00038 #endif /* __cplusplus */
00039 
00040 /*************************************************************************
00041  Enumerated Types
00042 *************************************************************************/
00043 
00044 /** SCUX channel number */
00045 typedef enum
00046 {
00047     SCUX_CH_0 = 0,   /**< Specifies SCUX0. */
00048     SCUX_CH_1 = 1,   /**< Specifies SCUX1. */
00049     SCUX_CH_2 = 2,   /**< Specifies SCUX2. */
00050     SCUX_CH_3 = 3,   /**< Specifies SCUX3. */
00051     SCUX_CH_NUM = 4  /**< Number of SCUX channels. */
00052 } scux_ch_num_t;
00053 
00054 /** used audio channel number setting */
00055 typedef enum
00056 {
00057     SCUX_USE_CH_1 = 1,   /**< used audio channel number is 1 */
00058     SCUX_USE_CH_2 = 2,   /**< used audio channel number is 2 */
00059     SCUX_USE_CH_4 = 4,   /**< used audio channel number is 4 */
00060     SCUX_USE_CH_6 = 6,   /**< used audio channel number is 6 */
00061     SCUX_USE_CH_8 = 8    /**< used audio channel number is 8 */
00062 } scux_use_channel_t;
00063 
00064 /** SCUX data word length */
00065 typedef enum
00066 {
00067     SCUX_DATA_LEN_MIN      =(-1), /**< For data word length identification [unsettable] */
00068     SCUX_DATA_LEN_24       = 0,   /**< Runs with a data word length of 24 bits. */
00069     SCUX_DATA_LEN_16       = 1,   /**< Runs with a data word length of 16 bits. */
00070     SCUX_DATA_LEN_16_TO_24 = 2,   /**< Outputs 16-bit data in 24-bit mode. */
00071     SCUX_DATA_LEN_MAX      = 3    /**< For data word length identification [unsettable] */
00072 } scux_data_word_len_t;
00073 
00074 /******************************************************************************
00075 Macro definitions
00076 ******************************************************************************/
00077 
00078 /** Status of the request */
00079 #define SCUX_STAT_STOP    0  /**< Acceptance of requests is stopped */
00080 #define SCUX_STAT_IDLE    1  /**< Processing of all requests is completed and waiting for a request. */
00081 #define SCUX_STAT_TRANS   2  /**< Transfer in progress */
00082 
00083 #ifdef __cplusplus
00084 }
00085 #endif /* __cplusplus */
00086 
00087 #endif /* R_BSP_SCUXDEF_H */