blob: 6de4a9b815476c4653cc33939af9fcccb1e860f8 [file] [log] [blame]
/* Copyright (c) Imagination Technologies Ltd.
*
* The contents of this file are subject to the MIT license as set out below.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#ifndef HAL_PUBLIC_H
#define HAL_PUBLIC_H
/* Authors of third party hardware composer (HWC) modules will need to include
* this header to access functionality in the gralloc HAL.
*/
#define PVR_ANDROID_NATIVE_WINDOW_HAS_SYNC
//#define SUPPORT_ANDROID_MEMTRACK_HAL
#include <hardware/gralloc.h>
#include <hardware/hwcomposer.h>
#define ALIGN(x,a) (((x) + (a) - 1L) & ~((a) - 1L))
#define HW_ALIGN 32
#define CAMERA_ALIGN 64
/** YV12 specific (to handle different alignment) ****************************/
/* We must align YV12 to a multiple of 32bytes as NEON optimizations
* in stagefright require the YV12 planes to be 128bit aligned.
* while display controller requires 64 bytes alignement
*/
#define YV12_ALIGN 128
#define HAL_PIXEL_FORMAT_BGRX_8888 0x101 // Keep consistent with android_utils.h
enum {
HAL_PIXEL_FORMAT_NV12 = 0x3231564E, // YCrCb 4:2:0 SP
HAL_PIXEL_FORMAT_NV21 = 0x3132564E, // YCrCb 4:2:0 SP
HAL_PIXEL_FORMAT_I420 = 0x30323449,
HAL_PIXEL_FORMAT_YUY2 = 0x32595559,
HAL_PIXEL_FORMAT_UYVY = 0x59565955,
// Intel video decode formats
HAL_PIXEL_FORMAT_NV12_VED = 0x7FA00E00, //OMX_INTEL_COLOR_FormatYUV420PackedSemiPlanar
HAL_PIXEL_FORMAT_NV12_VEDT = 0x7FA00F00, //OMX_INTEL_COLOR_FormatYUV420PackedSemiPlanar_Tiled
HAL_PIXEL_FORMAT_YCbCr_422_P = 0x12, // IYUV
HAL_PIXEL_FORMAT_YCbCr_420_P = 0x13, // YUV9
HAL_PIXEL_FORMAT_YCbCr_420_I = 0x15,
HAL_PIXEL_FORMAT_INTEL_UYVY = 0x107,
HAL_PIXEL_FORMAT_YCbCr_420_SP = 0x108,
HAL_PIXEL_FORMAT_ZSL = 0x109,
};
/* This can be tuned down as appropriate for the SOC.
*
* IMG formats are usually a single sub-alloc.
* Some OEM video formats are two sub-allocs (Y, UV planes).
* Future OEM video formats might be three sub-allocs (Y, U, V planes).
*/
#define MAX_SUB_ALLOCS 3
/* This defines the maximum server sync objects used per allocation. */
/* Note: It's unfortunate that we have to change the handle size dependent
* on a build option, but we have no choice because 'fd' fields must all
* be utilized so they are valid to be dup'ed, and we don't need some of
* the extra fds in a native_fence_sync build.
*/
#if defined(PVR_ANDROID_NATIVE_WINDOW_HAS_SYNC)
#define MAX_SRV_SYNC_OBJS 2
#else
#define MAX_SRV_SYNC_OBJS 4
#endif
typedef struct
{
native_handle_t base;
/* These fields can be sent cross process. They are also valid
* to duplicate within the same process.
*
* A table is stored within psPrivateData on gralloc_module_t (this
* is obviously per-process) which maps stamps to a mapped
* PVRSRV_MEMDESC in that process. Each map entry has a lock
* count associated with it, satisfying the requirements of the
* Android API. This also prevents us from leaking maps/allocations.
*
* This table has entries inserted either by alloc()
* (alloc_device_t) or map() (gralloc_module_t). Entries are removed
* by free() (alloc_device_t) and unmap() (gralloc_module_t).
*/
#define IMG_NATIVE_HANDLE_NUMFDS (MAX_SRV_SYNC_OBJS + MAX_SUB_ALLOCS)
/* The `syncfd' field is used to export PVRSRV_CLIENT_SYNC_PRIM to
* another process. Its producer/consumer rules should match the
* PVRSRV_MEMDESC handles, except that there is only one sync
* per N memdesc objects.
*
* This should be listed before `fd' because it is not variable
* width. The problem with variable width is that in the case we
* export framebuffer allocations, we may want to patch some of
* the fds to (unused) ints, so we can't leave gaps.
*/
int aiSyncFD[MAX_SRV_SYNC_OBJS];
/* The `fd' field is used to "export" a meminfo to another process.
* Therefore, it is allocated by alloc_device_t, and consumed by
* gralloc_module_t.
*/
int fd[MAX_SUB_ALLOCS];
#define IMG_NATIVE_HANDLE_NUMINTS ((sizeof(unsigned long long) / sizeof(int)) + 5)
/* A KERNEL unique identifier for any exported kernel meminfo. Each
* exported kernel meminfo will have a unique stamp, but note that in
* userspace, several meminfos across multiple processes could have
* the same stamp. As the native_handle can be dup(2)'d, there could be
* multiple handles with the same stamp but different file descriptors.
*/
unsigned long long ui64Stamp;
/* This is used for buffer usage validation when locking a buffer,
* and also in WSEGL (for the composition bypass feature).
*/
int usage;
/* In order to do efficient cache flushes we need the buffer dimensions
* and format. These are available on the ANativeWindowBuffer,
* but the platform doesn't pass them down to the graphics HAL.
*
* These fields are also used in the composition bypass. In this
* capacity, these are the "real" values for the backing allocation.
*/
int iWidth;
int iHeight;
int iFormat;
unsigned int uiBpp;
}
__attribute__((aligned(sizeof(int)),packed)) IMG_native_handle_t;
typedef struct
{
int l, t, w, h;
}
IMG_write_lock_rect_t;
/* Keep this in sync with SGX */
typedef int (*IMG_buffer_format_compute_params_pfn)(
unsigned int uiPlane, int *piWidth, int *piHeight, int *piStride,
int *piVStride, unsigned long *pulPlaneOffset);
#define IMG_BFF_YUV (1 << 0)
#define IMG_BFF_UVCbCrORDERING (1 << 1)
#define IMG_BFF_CPU_CLEAR (1 << 2)
#define IMG_BFF_DONT_GPU_CLEAR (1 << 3)
#define IMG_BFF_PARTIAL_ALLOC (1 << 4)
#define IMG_BFF_NEVER_COMPRESS (1 << 5)
/* Keep this in sync with SGX */
typedef struct IMG_buffer_format_public_t
{
/* Buffer formats are returned as a linked list */
struct IMG_buffer_format_public_t *psNext;
/* HAL_PIXEL_FORMAT_... enumerant */
int iHalPixelFormat;
/* IMG_PIXFMT_... enumerant */
int iIMGPixelFormat;
/* Friendly name for format */
const char *const szName;
/* Bits (not bytes) per pixel */
unsigned int uiBpp;
/* Supported HW usage bits. If this is GRALLOC_USAGE_HW_MASK, all usages
* are supported. Used for HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED.
*/
int iSupportedUsage;
/* Allocation description flags */
unsigned int uiFlags;
/* Utility function for adjusting YUV per-plane parameters */
IMG_buffer_format_compute_params_pfn pfnComputeParams;
}
IMG_buffer_format_public_t;
#if defined(SUPPORT_ANDROID_MEMTRACK_HAL)
#include <hardware/memtrack.h>
typedef struct
{
/* Base memtrack record, copied to caller */
struct memtrack_record base;
/* Record type, for filtering cached records */
enum memtrack_type eType;
/* Process ID, for filtering cached records */
pid_t pid;
}
IMG_memtrack_record_public_t;
#endif /* defined(SUPPORT_ANDROID_MEMTRACK_HAL) */
typedef struct
{
/* The original hwc layer */
hwc_layer_1_t *psLayer;
/* Custom data for the display engine */
uint32_t custom;
}
IMG_hwc_layer_t;
typedef struct IMG_display_device_public_t {
int (*post)(struct IMG_display_device_public_t *dev, IMG_hwc_layer_t *layers,
int num_layers, int *releaseFenceFd);
} IMG_display_device_public_t;
typedef struct IMG_gralloc_module_public_t
{
gralloc_module_t base;
IMG_display_device_public_t *psDisplayDevice;
/* Gets the head of the linked list of all registered formats */
const IMG_buffer_format_public_t *(*GetBufferFormats)(void);
/* Functionality before this point should be in sync with SGX.
* After this point will be different.
*/
/* Custom-blit components in lieu of overlay hardware */
int (*Blit)(struct IMG_gralloc_module_public_t const *module,
buffer_handle_t src, buffer_handle_t dest,
int w, int h, int x, int y,
int transform,
int async);
int (*Blit3)(struct IMG_gralloc_module_public_t const *module,
unsigned long long ui64SrcStamp, int iSrcWidth,
int iSrcHeight, int iSrcFormat, int eSrcRotation,
buffer_handle_t dest, int eDestRotation);
#if defined(SUPPORT_ANDROID_MEMTRACK_HAL)
int (*GetMemTrackRecords)(struct IMG_gralloc_module_public_t const *module,
IMG_memtrack_record_public_t **ppsRecords,
size_t *puNumRecords);
#endif /* defined(SUPPORT_ANDROID_MEMTRACK_HAL) */
/* Walk the above list and return only the specified format */
const IMG_buffer_format_public_t *(*GetBufferFormat)(int iFormat);
/* intel hwc extension */
int (*getCpuAddress)(struct IMG_gralloc_module_public_t const *module,
buffer_handle_t handle,
void **virt, uint32_t *size);
int (*putCpuAddress)(struct IMG_gralloc_module_public_t const *module,
buffer_handle_t handle);
IMG_display_device_public_t *(*getDisplayDevice)(struct IMG_gralloc_module_public_t *module);
}
IMG_gralloc_module_public_t;
#endif /* HAL_PUBLIC_H */