hardware.h revision 80107f8e92e25e62c945600325f3e846477bc855 
1/*
2 * Copyright (C) 2008 The Android Open Source Project
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#ifndef ANDROID_INCLUDE_HARDWARE_HARDWARE_H
18#define ANDROID_INCLUDE_HARDWARE_HARDWARE_H
19
20#include <stdint.h>
21#include <sys/cdefs.h>
22
23#include <cutils/native_handle.h>
24
25__BEGIN_DECLS
26
27/*
28 * Value for the hw_module_t.tag field
29 */
30
31#define MAKE_TAG_CONSTANT(A,B,C,D) (((A) << 24) | ((B) << 16) | ((C) << 8) | (D))
32
33#define HARDWARE_MODULE_TAG MAKE_TAG_CONSTANT('H', 'W', 'M', 'T')
34#define HARDWARE_DEVICE_TAG MAKE_TAG_CONSTANT('H', 'W', 'D', 'T')
35
36struct hw_module_t;
37struct hw_module_methods_t;
38struct hw_device_t;
39
40/**
41 * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM
42 * and the fields of this data structure must begin with hw_module_t
43 * followed by module specific information.
44 */
45typedef struct hw_module_t {
46    /** tag must be initialized to HARDWARE_MODULE_TAG */
47    uint32_t tag;
48
49    /** major version number for the module */
50    uint16_t version_major;
51
52    /** minor version number of the module */
53    uint16_t version_minor;
54
55    /** Identifier of module */
56    const char *id;
57
58    /** Name of this module */
59    const char *name;
60
61    /** Author/owner/implementor of the module */
62    const char *author;
63
64    /** Modules methods */
65    struct hw_module_methods_t* methods;
66
67    /** module's dso */
68    void* dso;
69
70    /** padding to 128 bytes, reserved for future use */
71    uint32_t reserved[32-7];
72
73} hw_module_t;
74
75typedef struct hw_module_methods_t {
76    /** Open a specific device */
77    int (*open)(const struct hw_module_t* module, const char* id,
78            struct hw_device_t** device);
79
80} hw_module_methods_t;
81
82/**
83 * Every device data structure must begin with hw_device_t
84 * followed by module specific public methods and attributes.
85 */
86typedef struct hw_device_t {
87    /** tag must be initialized to HARDWARE_DEVICE_TAG */
88    uint32_t tag;
89
90    /** version number for hw_device_t */
91    uint32_t version;
92
93    /** reference to the module this device belongs to */
94    struct hw_module_t* module;
95
96    /** padding reserved for future use */
97    uint32_t reserved[12];
98
99    /** Close this device */
100    int (*close)(struct hw_device_t* device);
101
102} hw_device_t;
103
104/**
105 * Name of the hal_module_info
106 */
107#define HAL_MODULE_INFO_SYM         HMI
108
109/**
110 * Name of the hal_module_info as a string
111 */
112#define HAL_MODULE_INFO_SYM_AS_STR  "HMI"
113
114/**
115 * Get the module info associated with a module by id.
116 * @return: 0 == success, <0 == error and *pHmi == NULL
117 */
118int hw_get_module(const char *id, const struct hw_module_t **module);
119
120
121/**
122 * pixel format definitions
123 */
124
125enum {
126    HAL_PIXEL_FORMAT_RGBA_8888          = 1,
127    HAL_PIXEL_FORMAT_RGBX_8888          = 2,
128    HAL_PIXEL_FORMAT_RGB_888            = 3,
129    HAL_PIXEL_FORMAT_RGB_565            = 4,
130    HAL_PIXEL_FORMAT_BGRA_8888          = 5,
131    HAL_PIXEL_FORMAT_RGBA_5551          = 6,
132    HAL_PIXEL_FORMAT_RGBA_4444          = 7,
133
134    /* 0x8 - 0xFF range unavailable */
135
136    /*
137     * 0x100 - 0x1FF
138     *
139     * This range is reserved for HAL implementations. OEMs can use
140     * any value in this range to communicate formats between their HAL
141     * modules
142     *
143     */
144
145    /*
146     * Android YUV format:
147     *
148     * This format is exposed outside of the HAL to software
149     * decoders and applications.
150     * EGLImageKHR must support it in conjunction with the
151     * OES_EGL_image_external extension.
152     *
153     * YV12 is 4:2:0 YCrCb planar format comprised of a WxH Y plane followed
154     * by (W/2) x (H/2) Cr and Cb planes.
155     *
156     * This format assumes an horizontal stride of 16 pixels for all planes
157     * and an implicit vertical stride of the image height's next multiple
158     * of two:
159     *   y_size = stride * ALIGN(height, 2)
160     *   c_size = ALIGN(stride/2, 16) * height
161     *   size = y_size + c_size * 2
162     *   cr_offset = y_size
163     *   cb_offset = y_size + c_size
164     *
165     */
166    HAL_PIXEL_FORMAT_YV12   = 0x32315659, // YCrCb 4:2:0 Planar
167
168
169
170    /* Legacy formats (deprecated), used by ImageFormat.java */
171    HAL_PIXEL_FORMAT_YCbCr_422_SP       = 0x10, // NV16
172    HAL_PIXEL_FORMAT_YCrCb_420_SP       = 0x11, // NV21
173    HAL_PIXEL_FORMAT_YCbCr_422_I        = 0x14, // YUY2
174    HAL_PIXEL_FORMAT_YCbCr_420_SP_TILED = 0x20, // NV12_adreno_tiled
175};
176
177
178/**
179 * Transformation definitions
180 */
181
182enum {
183    /* flip source image horizontally */
184    HAL_TRANSFORM_FLIP_H    = 0x01,
185    /* flip source image vertically */
186    HAL_TRANSFORM_FLIP_V    = 0x02,
187    /* rotate source image 90 degrees */
188    HAL_TRANSFORM_ROT_90    = 0x04,
189    /* rotate source image 180 degrees */
190    HAL_TRANSFORM_ROT_180   = 0x03,
191    /* rotate source image 270 degrees */
192    HAL_TRANSFORM_ROT_270   = 0x07,
193};
194
195__END_DECLS
196
197#endif  /* ANDROID_INCLUDE_HARDWARE_HARDWARE_H */
198