1 /* 2 * Copyright (C) 2017 C-SKY Microsystems Co., Ltd. All rights reserved. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 /****************************************************************************** 18 * @file drv_common.h 19 * @brief Header File for Common Driver 20 * @version V1.0 21 * @date 02. June 2017 22 ******************************************************************************/ 23 24 #ifndef _DRV_COMMON_H_ 25 #define _DRV_COMMON_H_ 26 27 #include <stdint.h> 28 #include <drv_errno.h> 29 30 /// \details driver handle 31 typedef void *drv_handle_t; 32 33 #ifndef CONFIG_PARAM_NOT_CHECK 34 #define HANDLE_PARAM_CHK(para, err) \ 35 do { \ 36 if (para == NULL) { \ 37 return (err); \ 38 } \ 39 } while (0) 40 #else 41 #define HANDLE_PARAM_CHK(para, err) 42 #endif 43 44 /** 45 \brief General power states 46 */ 47 typedef enum { 48 DRV_POWER_OFF, ///< Power off: no operation possible 49 DRV_POWER_LOW, ///< Low Power mode: retain state, detect and signal wake-up events 50 DRV_POWER_FULL, ///< Power on: full operation at maximum performance 51 DRV_POWER_SUSPEND, ///< Power suspend: power saving operation 52 } csi_power_stat_e; 53 54 #endif /* _DRV_COMMON_H */ 55