• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2020-2021 Huawei Device Co., Ltd.
3  *
4  * HDF is dual licensed: you can use it either under the terms of
5  * the GPL, or the BSD license, at your option.
6  * See the LICENSE file in the root of this repository for complete details.
7  */
8 
9 /**
10  * @addtogroup COMMON
11  * @{
12  *
13  * @brief Provides common APIs of the platform driver.
14  *
15  * This module also provides <b>DevHandle</b>, which represents the common data structure of the platform driver.
16  *
17  * @since 1.0
18  */
19 
20 /**
21  * @file platform_if.h
22  *
23  * @brief Declares common APIs of the platform driver.
24  *
25  * @since 1.0
26  */
27 
28 #ifndef PLATFORM_IF_H
29 #define PLATFORM_IF_H
30 
31 #include "hdf_base.h"
32 
33 #ifdef __cplusplus
34 #if __cplusplus
35 extern "C" {
36 #endif
37 #endif /* __cplusplus */
38 
39 /**
40  * @brief Defines the common device handle of the platform driver.
41  *
42  * The handle is associated with a specific platform device and is used as the
43  * first input parameter for all APIs of the platform driver.
44  *
45  * @since 1.0
46  */
47 typedef void* DevHandle;
48 
49 #ifdef __cplusplus
50 #if __cplusplus
51 }
52 #endif
53 #endif /* __cplusplus */
54 
55 #endif /* PLATFORM_IF_H */
56 /** @} */
57