libkms/libkms.h

   1 /**************************************************************************
   2  *
   3  * Copyright © 2009 VMware, Inc., Palo Alto, CA., USA
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28
  29 #ifndef _LIBKMS_H_
  30 #define _LIBKMS_H_
  31
  32 #if defined(__cplusplus)
  33 extern "C" {
  34 #endif
  35
  36 /**
  37  * \file
  38  *
  39  */
  40
  41 struct kms_driver;
  42 struct kms_bo;
  43
  44 enum kms_attrib
  45 {
  46         KMS_TERMINATE_PROP_LIST,
  47 #define KMS_TERMINATE_PROP_LIST KMS_TERMINATE_PROP_LIST
  48         KMS_BO_TYPE,
  49 #define KMS_BO_TYPE KMS_BO_TYPE
  50         KMS_WIDTH,
  51 #define KMS_WIDTH KMS_WIDTH
  52         KMS_HEIGHT,
  53 #define KMS_HEIGHT KMS_HEIGHT
  54         KMS_PITCH,
  55 #define KMS_PITCH KMS_PITCH
  56         KMS_HANDLE,
  57 #define KMS_HANDLE KMS_HANDLE
  58 };
  59
  60 enum kms_bo_type
  61 {
  62         KMS_BO_TYPE_SCANOUT_X8R8G8B8 = (1 << 0),
  63 #define KMS_BO_TYPE_SCANOUT_X8R8G8B8 KMS_BO_TYPE_SCANOUT_X8R8G8B8
  64         KMS_BO_TYPE_CURSOR_64X64_A8R8G8B8 =  (1 << 1),
  65 #define KMS_BO_TYPE_CURSOR_64X64_A8R8G8B8 KMS_BO_TYPE_CURSOR_64X64_A8R8G8B8
  66 };
  67
  68 int kms_create(int fd, struct kms_driver **out);
  69 int kms_get_prop(struct kms_driver *kms, unsigned key, unsigned *out);
  70 int kms_destroy(struct kms_driver **kms);
  71
  72 int kms_bo_create(struct kms_driver *kms, const unsigned *attr, struct kms_bo **out);
  73 int kms_bo_get_prop(struct kms_bo *bo, unsigned key, unsigned *out);
  74 int kms_bo_map(struct kms_bo *bo, void **out);
  75 int kms_bo_unmap(struct kms_bo *bo);
  76 int kms_bo_destroy(struct kms_bo **bo);
  77
  78 #if defined(__cplusplus)
  79 };
  80 #endif
  81
  82 #endif