hw/common.h

   1 /*
   2  * libdevice-node
   3  *
   4  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the License);
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19
  20 #ifndef __HW_COMMON_H__
  21 #define __HW_COMMON_H__
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 #include <stdint.h>
  28
  29 #define MAKE_TAG_CONSTANT(A,B,C,D)      (((A) << 24) | ((B) << 16) | ((C) << 8) | (D))
  30 #define HARDWARE_INFO_TAG       MAKE_TAG_CONSTANT('T','H','I','T')
  31
  32 struct hw_common;
  33 struct hw_info {
  34         /* magic must be initialized to HARDWARE_INFO_TAG */
  35         uint32_t magic;
  36         /* HAL version */
  37         uint16_t hal_version;
  38         /* device version */
  39         uint16_t device_version;
  40         /* device id */
  41         const char *id;
  42         /* device name */
  43         const char *name;
  44         /* author name */
  45         const char *author;
  46         /* module's dso */
  47         void *dso;
  48         /* reserved for future use */
  49         uint32_t reserved[8];
  50         /* open device */
  51         int (*open)(struct hw_info *info,
  52                         const char *id, struct hw_common **common);
  53         /* close device */
  54         int (*close)(struct hw_common *common);
  55 };
  56
  57 struct hw_common {
  58         /* indicate to this device information structure */
  59         struct hw_info *info;
  60 };
  61
  62 #define MAKE_VERSION(maj,min) \
  63         ((((maj) & 0xff) << 8) | ((min) & 0xff))
  64
  65 /**
  66  * Version of the struct hw_info
  67  */
  68 #define HARDWARE_INFO_VERSION   MAKE_VERSION(1,0)
  69
  70 /**
  71  * Name of the hardware info symbolic (Tizen Hardware Info)
  72  */
  73 #define HARDWARE_INFO_SYM               TizenHwInfo
  74
  75 int hw_get_info(const char *id, const struct hw_info **info);
  76
  77 /**
  78  * Structure define of hardware info module
  79  * All hardware module should be use below define
  80  * to make a specific structure for Tizen HAL.
  81  * hw_get_info function will load a hw_info structure
  82  * by using TizenHwInfo name at runtime.
  83  * TizenHwInfo means Tizen Hardware Info.
  84  */
  85 #define HARDWARE_MODULE_STRUCTURE       \
  86         __attribute__ ((visibility("default"))) \
  87         struct hw_info HARDWARE_INFO_SYM
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif
  94