clib_drivers_typedef.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) 2013 - 2015 Renesas Electronics Corporation. All rights reserved.
00022 *******************************************************************************/
00023 /**
00024 * @file  clib_drivers_typedef.h
00025 * @brief   $Module: CLibCommon $ $PublicVersion: 0.90 $ (=CLIB_VERSION)
00026 * $Rev: 30 $
00027 * $Date:: 2014-02-13 21:21:47 +0900#$
00028 * - Description: Common code for drivers and more.
00029 */
00030 
00031 #ifndef  CLIB_DRIVERS_TYPEDEF_H
00032 #define  CLIB_DRIVERS_TYPEDEF_H
00033 
00034 /******************************************************************************
00035 Includes   <System Includes> , "Project Includes"
00036 ******************************************************************************/
00037 #include  "Project_Config.h"
00038 
00039 #ifdef __cplusplus
00040 extern "C" {
00041 #endif /* __cplusplus */
00042 
00043 
00044 /******************************************************************************
00045 Typedef definitions
00046 ******************************************************************************/
00047 
00048 /**
00049 * @typedef  bool32_t
00050 * @brief  Boolean type in 32 bit variable. This is not C99.
00051 */
00052 typedef  unsigned int    bool32_t;
00053 
00054 
00055 /**
00056 * @typedef  bool16_t
00057 * @brief  Boolean type in 16 bit variable. This is not C99.
00058 */
00059 typedef  unsigned short  bool16_t;
00060 
00061 
00062 /**
00063 * @typedef  bool8_t
00064 * @brief  Boolean type in 8 bit variable. This is not C99.
00065 */
00066 typedef  unsigned char   bool8_t;
00067 
00068 
00069 /**
00070 * @typedef  IntBoxType
00071 * @brief  IntBoxType
00072 */
00073 typedef struct st_IntBoxType  IntBoxType;
00074 struct st_IntBoxType {
00075     int  MinX;
00076     int  MinY;
00077     int  Width;
00078     int  Height;
00079 };
00080 
00081 
00082 /******************************************************************************
00083 Macro definitions
00084 ******************************************************************************/
00085 
00086 /**
00087 * @def  DUMMY_INITIAL_VALUE
00088 * @brief  Avoids not right warning of not initialized.
00089 *
00090 * @par Description
00091 * - 0xDEDEDEDE means "not initialized".
00092 * - Disable VC++ warning C4701 : local variable may be used without having
00093 *   been initialized
00094 * - See @ref DUMMY_INITIAL_VALUE_8BIT, @ref DUMMY_INITIAL_VALUE_16BIT
00095 */
00096 #ifndef  R_OSPL_NDEBUG
00097 #define  DUMMY_INITIAL_VALUE  0xDEDEDEDE
00098 #else
00099 enum { DUMMY_INITIAL_VALUE = 0 };
00100 #endif
00101 
00102 
00103 /**
00104 * @def  DUMMY_INITIAL_VALUE_8BIT
00105 * @brief  <DUMMY_INITIAL_VALUE> for 8 bit integer.
00106 */
00107 #ifndef  R_OSPL_NDEBUG
00108 enum { DUMMY_INITIAL_VALUE_8BIT  = 0xDE };
00109 #else
00110 enum { DUMMY_INITIAL_VALUE_8BIT  = 0 };
00111 #endif
00112 
00113 
00114 /**
00115 * @def  DUMMY_INITIAL_VALUE_16BIT
00116 * @brief  <DUMMY_INITIAL_VALUE> for 16 bit integer.
00117 */
00118 #ifndef  R_OSPL_NDEBUG
00119 enum { DUMMY_INITIAL_VALUE_16BIT = 0xDEDE };
00120 #else
00121 enum { DUMMY_INITIAL_VALUE_16BIT = 0 };
00122 #endif
00123 
00124 
00125 /**
00126 * @def  U8_255
00127 * @brief  Magic number of generally well known used.
00128 *    unsigned 8bit max value = UINT8_MAX
00129 */
00130 #define  U8_255   255
00131 
00132 
00133 /**
00134 * @def  R_CEIL_2U
00135 * @brief  Fast ceil operation. Macro version. See <R_Ceil_N>.
00136 * @par Parameters
00137 *    None
00138 * @return  None.
00139 */
00140 #define  R_CEIL_2U( value )   (((value)+1)&~1)
00141 
00142 
00143 /**
00144 * @def  R_CEIL_4U
00145 * @brief  Fast ceil operation. Macro version. See <R_Ceil_N>.
00146 * @par Parameters
00147 *    None
00148 * @return  None.
00149 */
00150 #define  R_CEIL_4U( value )   (((value)+3)&~3)
00151 
00152 
00153 /**
00154 * @def  R_CEIL_8U
00155 * @brief  Fast ceil operation. Macro version. See <R_Ceil_N>.
00156 * @par Parameters
00157 *    None
00158 * @return  None.
00159 */
00160 #define  R_CEIL_8U( value )   (((value)+7)&~7)
00161 
00162 
00163 /**
00164 * @def  R_CEIL_16U
00165 * @brief  Fast ceil operation. Macro version. See <R_Ceil_N>.
00166 * @par Parameters
00167 *    None
00168 * @return  None.
00169 */
00170 #define  R_CEIL_16U( value )  (((value)+15)&~15)
00171 
00172 
00173 /**
00174 * @def  R_CEIL_32U
00175 * @brief  Fast ceil operation. Macro version. See <R_Ceil_N>.
00176 * @par Parameters
00177 *    None
00178 * @return  None.
00179 */
00180 #define  R_CEIL_32U( value )  (((value)+31)&~31)
00181 
00182 
00183 /**
00184 * @def  R_CEIL_64U
00185 * @brief  Fast ceil operation. Macro version. See <R_Ceil_N>.
00186 * @par Parameters
00187 *    None
00188 * @return  None.
00189 */
00190 #define  R_CEIL_64U( value )  (((value)+63)&~63)
00191 
00192 
00193 /******************************************************************************
00194 Variable Externs
00195 ******************************************************************************/
00196 
00197 /******************************************************************************
00198 Functions Prototypes
00199 ******************************************************************************/
00200 
00201 #ifdef __cplusplus
00202 }  /* extern "C" */
00203 #endif /* __cplusplus */
00204 
00205 #endif  /* CLIB_DRIVERS_TYPEDEF_H */
00206