hwcomposer.cpp - android_external_drm_hwcomposer - Gitiles

 /*
  * Copyright (C) 2015 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 #define LOG_TAG "hwcomposer-drm"

 #include "drm_hwcomposer.h"
 #include "drmresources.h"
 #include "gl_compositor.h"
 #include "importer.h"
 #include "vsyncworker.h"

 #include <errno.h>
 #include <fcntl.h>
 #include <list>
 #include <map>
 #include <pthread.h>
 #include <stdlib.h>
 #include <sys/param.h>
 #include <sys/resource.h>
 #include <xf86drm.h>
 #include <xf86drmMode.h>

 #include <cutils/log.h>
 #include <cutils/properties.h>
 #include <hardware/hardware.h>
 #include <hardware/hwcomposer.h>
 #include <sw_sync.h>
 #include <sync/sync.h>
 #include <ui/GraphicBuffer.h>
 #include <ui/PixelFormat.h>

 #define UM_PER_INCH 25400
 #define HWC_FB_BUFFERS 3

 namespace android {

 struct hwc_drm_display_framebuffer {
   hwc_drm_display_framebuffer() : release_fence_fd_(-1) {
   }

   ~hwc_drm_display_framebuffer() {
     if (release_fence_fd() >= 0)
       close(release_fence_fd());
   }

   bool is_valid() {
     return buffer_ != NULL;
   }

   sp<GraphicBuffer> buffer() {
     return buffer_;
   }

   int release_fence_fd() {
     return release_fence_fd_;
   }

   void set_release_fence_fd(int fd) {
     if (release_fence_fd_ >= 0)
       close(release_fence_fd_);
     release_fence_fd_ = fd;
   }

   bool Allocate(uint32_t w, uint32_t h) {
     if (is_valid()) {
       if (buffer_->getWidth() == w && buffer_->getHeight() == h)
         return true;

       if (release_fence_fd_ >= 0) {
         if (sync_wait(release_fence_fd_, -1) != 0) {
           return false;
         }
       }
       Clear();
     }
     buffer_ = new GraphicBuffer(w, h, android::PIXEL_FORMAT_RGBA_8888,
                                 GRALLOC_USAGE_HW_FB | GRALLOC_USAGE_HW_RENDER |
                                     GRALLOC_USAGE_HW_COMPOSER);
     release_fence_fd_ = -1;
     return is_valid();
   }

   void Clear() {
     if (!is_valid())
       return;

     if (release_fence_fd_ >= 0) {
       close(release_fence_fd_);
       release_fence_fd_ = -1;
     }

     buffer_.clear();
   }

   int WaitReleased(int timeout_milliseconds) {
     if (!is_valid())
       return 0;
     if (release_fence_fd_ < 0)
       return 0;

     int ret = sync_wait(release_fence_fd_, timeout_milliseconds);
     return ret;
   }

  private:
   sp<GraphicBuffer> buffer_;
   int release_fence_fd_;
 };


 typedef struct hwc_drm_display {
   struct hwc_context_t *ctx;
   int display;

   std::vector<uint32_t> config_ids;

   VSyncWorker vsync_worker;

   hwc_drm_display_framebuffer fb_chain[HWC_FB_BUFFERS];
   int fb_idx;
 } hwc_drm_display_t;

 struct hwc_context_t {
   // map of display:hwc_drm_display_t
   typedef std::map<int, hwc_drm_display_t> DisplayMap;
   typedef DisplayMap::iterator DisplayMapIter;

   hwc_context_t() : procs(NULL), importer(NULL) {
   }

   ~hwc_context_t() {
     delete importer;
   }

   hwc_composer_device_1_t device;
   hwc_procs_t const *procs;

   DisplayMap displays;
   DrmResources drm;
   Importer *importer;
   GLCompositor pre_compositor;
 };

 static void hwc_dump(struct hwc_composer_device_1* dev, char *buff,
                      int buff_len) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;
   std::ostringstream out;

   ctx->drm.compositor()->Dump(&out);
   std::string out_str = out.str();
   strncpy(buff, out_str.c_str(), std::min((size_t)buff_len, out_str.length()));
 }

 static int hwc_prepare(hwc_composer_device_1_t *dev, size_t num_displays,
                        hwc_display_contents_1_t **display_contents) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;
   for (int i = 0; i < (int)num_displays; ++i) {
     if (!display_contents[i])
       continue;

     DrmCrtc *crtc = ctx->drm.GetCrtcForDisplay(i);
     if (!crtc) {
       ALOGE("No crtc for display %d", i);
       return -ENODEV;
     }

     int num_layers = display_contents[i]->numHwLayers;
     for (int j = 0; j < num_layers; j++) {
       hwc_layer_1_t *layer = &display_contents[i]->hwLayers[j];

       if (layer->compositionType == HWC_FRAMEBUFFER)
         layer->compositionType = HWC_OVERLAY;
     }
   }

   return 0;
 }

 static void hwc_set_cleanup(size_t num_displays,
                             hwc_display_contents_1_t **display_contents,
                             Composition *composition) {
   for (int i = 0; i < (int)num_displays; ++i) {
     if (!display_contents[i])
       continue;

     hwc_display_contents_1_t *dc = display_contents[i];
     for (size_t j = 0; j < dc->numHwLayers; ++j) {
       hwc_layer_1_t *layer = &dc->hwLayers[j];
       if (layer->acquireFenceFd >= 0) {
         close(layer->acquireFenceFd);
         layer->acquireFenceFd = -1;
       }
     }
     if (dc->outbufAcquireFenceFd >= 0) {
       close(dc->outbufAcquireFenceFd);
       dc->outbufAcquireFenceFd = -1;
     }
   }

   delete composition;
 }

 static int hwc_add_layer(int display, hwc_context_t *ctx, hwc_layer_1_t *layer,
                          Composition *composition) {
   hwc_drm_bo_t bo;
   int ret = ctx->importer->ImportBuffer(layer->handle, &bo);
   if (ret) {
     ALOGE("Failed to import handle to bo %d", ret);
     return ret;
   }

   ret = composition->AddLayer(display, layer, &bo);
   if (!ret)
     return 0;

   int destroy_ret = ctx->importer->ReleaseBuffer(&bo);
   if (destroy_ret)
     ALOGE("Failed to destroy buffer %d", destroy_ret);

   return ret;
 }

 static int hwc_set(hwc_composer_device_1_t *dev, size_t num_displays,
                    hwc_display_contents_1_t **display_contents) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;
   Composition *composition =
       ctx->drm.compositor()->CreateComposition(ctx->importer);
   if (!composition) {
     ALOGE("Drm composition init failed");
     hwc_set_cleanup(num_displays, display_contents, NULL);
     return -EINVAL;
   }

   int ret;
   for (int i = 0; i < (int)num_displays; ++i) {
     if (!display_contents[i])
       continue;

     hwc_display_contents_1_t *dc = display_contents[i];
     int j;
     unsigned num_layers = 0;
     unsigned num_dc_layers = dc->numHwLayers;
     for (j = 0; j < (int)num_dc_layers; ++j) {
       hwc_layer_1_t *layer = &dc->hwLayers[j];
       if (layer->flags & HWC_SKIP_LAYER)
         continue;
       if (layer->compositionType == HWC_OVERLAY)
         num_layers++;
     }

     unsigned num_planes = composition->GetRemainingLayers(i, num_layers);
     bool use_pre_compositor = false;

     if (num_layers > num_planes) {
       use_pre_compositor = true;
       // Reserve one of the planes for the result of the pre compositor.
       num_planes--;
     }

     for (j = 0; num_planes && j < (int)num_dc_layers; ++j) {
       hwc_layer_1_t *layer = &dc->hwLayers[j];
       if (layer->flags & HWC_SKIP_LAYER)
         continue;
       if (layer->compositionType != HWC_OVERLAY)
         continue;

       ret = hwc_add_layer(i, ctx, layer, composition);
       if (ret) {
         ALOGE("Add layer failed %d", ret);
         hwc_set_cleanup(num_displays, display_contents, composition);
         return ret;
       }
       --num_planes;
     }

     int last_comp_layer = j;

     if (use_pre_compositor) {
       hwc_drm_display_t *hd = &ctx->displays[i];
       struct hwc_drm_display_framebuffer *fb = &hd->fb_chain[hd->fb_idx];
       ret = fb->WaitReleased(-1);
       if (ret) {
         ALOGE("Failed to wait for framebuffer %d", ret);
         hwc_set_cleanup(num_displays, display_contents, composition);
         return ret;
       }

       DrmConnector *connector = ctx->drm.GetConnectorForDisplay(i);
       if (!connector) {
         ALOGE("No connector for display %d", i);
         hwc_set_cleanup(num_displays, display_contents, composition);
         return -ENODEV;
       }

       const DrmMode &mode = connector->active_mode();
       if (!fb->Allocate(mode.h_display(), mode.v_display())) {
         ALOGE("Failed to allocate framebuffer with size %dx%d",
               mode.h_display(), mode.v_display());
         hwc_set_cleanup(num_displays, display_contents, composition);
         return -EINVAL;
       }

       sp<GraphicBuffer> fb_buffer = fb->buffer();
       if (fb_buffer == NULL) {
         ALOGE("Framebuffer is NULL");
         hwc_set_cleanup(num_displays, display_contents, composition);
         return -EINVAL;
       }

       Targeting *targeting = ctx->pre_compositor.targeting();
       if (targeting == NULL) {
         ALOGE("Pre-compositor does not support targeting");
         hwc_set_cleanup(num_displays, display_contents, composition);
         return -EINVAL;
       }

       int target = targeting->CreateTarget(fb_buffer);
       targeting->SetTarget(target);

       Composition *pre_composition = ctx->pre_compositor.CreateComposition(ctx->importer);
       if (pre_composition == NULL) {
         ALOGE("Failed to create pre-composition");
         targeting->ForgetTarget(target);
         hwc_set_cleanup(num_displays, display_contents, composition);
         return -EINVAL;
       }

       for (j = last_comp_layer; j < (int)num_dc_layers; ++j) {
         hwc_layer_1_t *layer = &dc->hwLayers[j];
         if (layer->flags & HWC_SKIP_LAYER)
           continue;
         if (layer->compositionType != HWC_OVERLAY)
           continue;
         ret = hwc_add_layer(i, ctx, layer, pre_composition);
         if (ret) {
           ALOGE("Add layer failed %d", ret);
           delete pre_composition;
           targeting->ForgetTarget(target);
           hwc_set_cleanup(num_displays, display_contents, composition);
           return ret;
         }
       }

       ret = ctx->pre_compositor.QueueComposition(pre_composition);
       pre_composition = NULL;

       targeting->ForgetTarget(target);
       if (ret < 0 && ret != -EALREADY) {
         ALOGE("Pre-composition failed %d", ret);
         hwc_set_cleanup(num_displays, display_contents, composition);
         return ret;
       }

       for (j = last_comp_layer; j < (int)num_dc_layers; ++j) {
         hwc_layer_1_t *layer = &dc->hwLayers[j];
         if (layer->flags & HWC_SKIP_LAYER)
           continue;
         if (layer->compositionType != HWC_OVERLAY)
           continue;
         layer->acquireFenceFd = -1;
       }

       hwc_layer_1_t composite_layer;
       hwc_rect_t visible_rect;
       memset(&composite_layer, 0, sizeof(composite_layer));
       memset(&visible_rect, 0, sizeof(visible_rect));

       composite_layer.compositionType = HWC_OVERLAY;
       composite_layer.handle = fb_buffer->getNativeBuffer()->handle;
       composite_layer.sourceCropf.right = composite_layer.displayFrame.right =
           visible_rect.right = fb_buffer->getWidth();
       composite_layer.sourceCropf.bottom = composite_layer.displayFrame.bottom =
           visible_rect.bottom = fb_buffer->getHeight();
       composite_layer.visibleRegionScreen.numRects = 1;
       composite_layer.visibleRegionScreen.rects = &visible_rect;
       composite_layer.acquireFenceFd = ret == -EALREADY ? -1 : ret;
       // A known invalid fd in case AddLayer does not modify this field.
       composite_layer.releaseFenceFd = -1;
       composite_layer.planeAlpha = 0xff;

       ret = hwc_add_layer(i, ctx, &composite_layer, composition);
       if (ret) {
         ALOGE("Add layer failed %d", ret);
         hwc_set_cleanup(num_displays, display_contents, composition);
         return ret;
       }

       fb->set_release_fence_fd(composite_layer.releaseFenceFd);
       hd->fb_idx = (hd->fb_idx + 1) % HWC_FB_BUFFERS;
     }
   }

   ret = ctx->drm.compositor()->QueueComposition(composition);
   if (ret) {
     ALOGE("Failed to queue the composition");
     hwc_set_cleanup(num_displays, display_contents, composition);
     return ret;
   }
   hwc_set_cleanup(num_displays, display_contents, NULL);
   return ret;
 }

 static int hwc_event_control(struct hwc_composer_device_1 *dev, int display,
                              int event, int enabled) {
   if (event != HWC_EVENT_VSYNC || (enabled != 0 && enabled != 1))
     return -EINVAL;

   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;
   hwc_drm_display_t *hd = &ctx->displays[display];
   return hd->vsync_worker.VSyncControl(enabled);
 }

 static int hwc_set_power_mode(struct hwc_composer_device_1 *dev, int display,
                               int mode) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;

   uint64_t dpmsValue = 0;
   switch (mode) {
     case HWC_POWER_MODE_OFF:
       dpmsValue = DRM_MODE_DPMS_OFF;
       break;

     /* We can't support dozing right now, so go full on */
     case HWC_POWER_MODE_DOZE:
     case HWC_POWER_MODE_DOZE_SUSPEND:
     case HWC_POWER_MODE_NORMAL:
       dpmsValue = DRM_MODE_DPMS_ON;
       break;
   };
   return ctx->drm.SetDpmsMode(display, dpmsValue);
 }

 static int hwc_query(struct hwc_composer_device_1 * /* dev */, int what,
                      int *value) {
   switch (what) {
     case HWC_BACKGROUND_LAYER_SUPPORTED:
       *value = 0; /* TODO: We should do this */
       break;
     case HWC_VSYNC_PERIOD:
       ALOGW("Query for deprecated vsync value, returning 60Hz");
       *value = 1000 * 1000 * 1000 / 60;
       break;
     case HWC_DISPLAY_TYPES_SUPPORTED:
       *value = HWC_DISPLAY_PRIMARY | HWC_DISPLAY_EXTERNAL;
       break;
   }
   return 0;
 }

 static void hwc_register_procs(struct hwc_composer_device_1 *dev,
                                hwc_procs_t const *procs) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;

   ctx->procs = procs;

   for (hwc_context_t::DisplayMapIter iter = ctx->displays.begin();
        iter != ctx->displays.end(); ++iter) {
     iter->second.vsync_worker.SetProcs(procs);
   }
 }

 static int hwc_get_display_configs(struct hwc_composer_device_1 *dev,
                                    int display, uint32_t *configs,
                                    size_t *num_configs) {
   if (!*num_configs)
     return 0;

   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;
   hwc_drm_display_t *hd = &ctx->displays[display];
   hd->config_ids.clear();

   DrmConnector *connector = ctx->drm.GetConnectorForDisplay(display);
   if (!connector) {
     ALOGE("Failed to get connector for display %d", display);
     return -ENODEV;
   }

   int ret = connector->UpdateModes();
   if (ret) {
     ALOGE("Failed to update display modes %d", ret);
     return ret;
   }

   for (DrmConnector::ModeIter iter = connector->begin_modes();
        iter != connector->end_modes(); ++iter) {
     size_t idx = hd->config_ids.size();
     if (idx == *num_configs)
       break;
     hd->config_ids.push_back(iter->id());
     configs[idx] = iter->id();
   }
   *num_configs = hd->config_ids.size();
   return *num_configs == 0 ? -1 : 0;
 }

 static int hwc_get_display_attributes(struct hwc_composer_device_1 *dev,
                                       int display, uint32_t config,
                                       const uint32_t *attributes,
                                       int32_t *values) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;
   DrmConnector *c = ctx->drm.GetConnectorForDisplay(display);
   if (!c) {
     ALOGE("Failed to get DrmConnector for display %d", display);
     return -ENODEV;
   }
   DrmMode mode;
   for (DrmConnector::ModeIter iter = c->begin_modes(); iter != c->end_modes();
        ++iter) {
     if (iter->id() == config) {
       mode = *iter;
       break;
     }
   }
   if (mode.id() == 0) {
     ALOGE("Failed to find active mode for display %d", display);
     return -ENOENT;
   }

   uint32_t mm_width = c->mm_width();
   uint32_t mm_height = c->mm_height();
   for (int i = 0; attributes[i] != HWC_DISPLAY_NO_ATTRIBUTE; ++i) {
     switch (attributes[i]) {
       case HWC_DISPLAY_VSYNC_PERIOD:
         values[i] = 1000 * 1000 * 1000 / mode.v_refresh();
         break;
       case HWC_DISPLAY_WIDTH:
         values[i] = mode.h_display();
         break;
       case HWC_DISPLAY_HEIGHT:
         values[i] = mode.v_display();
         break;
       case HWC_DISPLAY_DPI_X:
         /* Dots per 1000 inches */
         values[i] = mm_width ? (mode.h_display() * UM_PER_INCH) / mm_width : 0;
         break;
       case HWC_DISPLAY_DPI_Y:
         /* Dots per 1000 inches */
         values[i] =
             mm_height ? (mode.v_display() * UM_PER_INCH) / mm_height : 0;
         break;
     }
   }
   return 0;
 }

 static int hwc_get_active_config(struct hwc_composer_device_1 *dev,
                                  int display) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;
   DrmConnector *c = ctx->drm.GetConnectorForDisplay(display);
   if (!c) {
     ALOGE("Failed to get DrmConnector for display %d", display);
     return -ENODEV;
   }

   DrmMode mode = c->active_mode();
   hwc_drm_display_t *hd = &ctx->displays[display];
   for (size_t i = 0; i < hd->config_ids.size(); ++i) {
     if (hd->config_ids[i] == mode.id())
       return i;
   }
   return -1;
 }

 static int hwc_set_active_config(struct hwc_composer_device_1 *dev, int display,
                                  int index) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)&dev->common;
   hwc_drm_display_t *hd = &ctx->displays[display];
   if (index >= (int)hd->config_ids.size()) {
     ALOGE("Invalid config index %d passed in", index);
     return -EINVAL;
   }

   DrmConnector *c = ctx->drm.GetConnectorForDisplay(display);
   if (!c) {
     ALOGE("Failed to get connector for display %d", display);
     return -ENODEV;
   }
   DrmMode mode;
   for (DrmConnector::ModeIter iter = c->begin_modes(); iter != c->end_modes();
        ++iter) {
     if (iter->id() == hd->config_ids[index]) {
       mode = *iter;
       break;
     }
   }
   if (mode.id() != hd->config_ids[index]) {
     ALOGE("Could not find active mode for %d/%d", index, hd->config_ids[index]);
     return -ENOENT;
   }
   int ret = ctx->drm.SetDisplayActiveMode(display, mode);
   if (ret) {
     ALOGE("Failed to set active config %d", ret);
     return ret;
   }
   return ret;
 }

 static int hwc_device_close(struct hw_device_t *dev) {
   struct hwc_context_t *ctx = (struct hwc_context_t *)dev;
   delete ctx;
   return 0;
 }

 /*
  * TODO: This function sets the active config to the first one in the list. This
  * should be fixed such that it selects the preferred mode for the display, or
  * some other, saner, method of choosing the config.
  */
 static int hwc_set_initial_config(hwc_drm_display_t *hd) {
   uint32_t config;
   size_t num_configs = 1;
   int ret = hwc_get_display_configs(&hd->ctx->device, hd->display, &config,
                                     &num_configs);
   if (ret || !num_configs)
     return 0;

   ret = hwc_set_active_config(&hd->ctx->device, hd->display, 0);
   if (ret) {
     ALOGE("Failed to set active config d=%d ret=%d", hd->display, ret);
     return ret;
   }

   return ret;
 }

 static int hwc_initialize_display(struct hwc_context_t *ctx, int display) {
   hwc_drm_display_t *hd = &ctx->displays[display];
   hd->ctx = ctx;
   hd->display = display;
   hd->fb_idx = 0;

   int ret = hwc_set_initial_config(hd);
   if (ret) {
     ALOGE("Failed to set initial config for d=%d ret=%d", display, ret);
     return ret;
   }

   ret = hd->vsync_worker.Init(&ctx->drm, display);
   if (ret) {
     ALOGE("Failed to create event worker for display %d %d\n", display, ret);
     return ret;
   }

   return 0;
 }

 static int hwc_enumerate_displays(struct hwc_context_t *ctx) {
   int ret;
   for (DrmResources::ConnectorIter c = ctx->drm.begin_connectors();
        c != ctx->drm.end_connectors(); ++c) {
     ret = hwc_initialize_display(ctx, (*c)->display());
     if (ret) {
       ALOGE("Failed to initialize display %d", (*c)->display());
       return ret;
     }
   }

   return 0;
 }

 static int hwc_device_open(const struct hw_module_t *module, const char *name,
                            struct hw_device_t **dev) {
   if (strcmp(name, HWC_HARDWARE_COMPOSER)) {
     ALOGE("Invalid module name- %s", name);
     return -EINVAL;
   }

   struct hwc_context_t *ctx = new hwc_context_t();
   if (!ctx) {
     ALOGE("Failed to allocate hwc context");
     return -ENOMEM;
   }

   int ret = ctx->drm.Init();
   if (ret) {
     ALOGE("Can't initialize Drm object %d", ret);
     delete ctx;
     return ret;
   }

   ret = ctx->pre_compositor.Init();
   if (ret) {
     ALOGE("Can't initialize OpenGL Compositor object %d", ret);
     delete ctx;
     return ret;
   }

   ctx->importer = Importer::CreateInstance(&ctx->drm);
   if (!ctx->importer) {
     ALOGE("Failed to create importer instance");
     delete ctx;
     return ret;
   }

   ret = hwc_enumerate_displays(ctx);
   if (ret) {
     ALOGE("Failed to enumerate displays: %s", strerror(ret));
     delete ctx;
     return ret;
   }

   ctx->device.common.tag = HARDWARE_DEVICE_TAG;
   ctx->device.common.version = HWC_DEVICE_API_VERSION_1_4;
   ctx->device.common.module = const_cast<hw_module_t *>(module);
   ctx->device.common.close = hwc_device_close;

   ctx->device.dump = hwc_dump;
   ctx->device.prepare = hwc_prepare;
   ctx->device.set = hwc_set;
   ctx->device.eventControl = hwc_event_control;
   ctx->device.setPowerMode = hwc_set_power_mode;
   ctx->device.query = hwc_query;
   ctx->device.registerProcs = hwc_register_procs;
   ctx->device.getDisplayConfigs = hwc_get_display_configs;
   ctx->device.getDisplayAttributes = hwc_get_display_attributes;
   ctx->device.getActiveConfig = hwc_get_active_config;
   ctx->device.setActiveConfig = hwc_set_active_config;
   ctx->device.setCursorPositionAsync = NULL; /* TODO: Add cursor */

   *dev = &ctx->device.common;

   return 0;
 }
 }

 static struct hw_module_methods_t hwc_module_methods = {
   open : android::hwc_device_open
 };

 hwc_module_t HAL_MODULE_INFO_SYM = {
   common : {
     tag : HARDWARE_MODULE_TAG,
     version_major : 1,
     version_minor : 0,
     id : HWC_HARDWARE_MODULE_ID,
     name : "DRM hwcomposer module",
     author : "The Android Open Source Project",
     methods : &hwc_module_methods,
     dso : NULL,
     reserved : {0},
   }
 };
	/*
	* Copyright (C) 2015 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	#define LOG_TAG "hwcomposer-drm"

	#include "drm_hwcomposer.h"
	#include "drmresources.h"
	#include "gl_compositor.h"
	#include "importer.h"
	#include "vsyncworker.h"

	#include <errno.h>
	#include <fcntl.h>
	#include <list>
	#include <map>
	#include <pthread.h>
	#include <stdlib.h>
	#include <sys/param.h>
	#include <sys/resource.h>
	#include <xf86drm.h>
	#include <xf86drmMode.h>

	#include <cutils/log.h>
	#include <cutils/properties.h>
	#include <hardware/hardware.h>
	#include <hardware/hwcomposer.h>
	#include <sw_sync.h>
	#include <sync/sync.h>
	#include <ui/GraphicBuffer.h>
	#include <ui/PixelFormat.h>

	#define UM_PER_INCH 25400
	#define HWC_FB_BUFFERS 3

	namespace android {

	struct hwc_drm_display_framebuffer {
	hwc_drm_display_framebuffer() : release_fence_fd_(-1) {
	}

	~hwc_drm_display_framebuffer() {
	if (release_fence_fd() >= 0)
	close(release_fence_fd());
	}

	bool is_valid() {
	return buffer_ != NULL;
	}

	sp<GraphicBuffer> buffer() {
	return buffer_;
	}

	int release_fence_fd() {
	return release_fence_fd_;
	}

	void set_release_fence_fd(int fd) {
	if (release_fence_fd_ >= 0)
	close(release_fence_fd_);
	release_fence_fd_ = fd;
	}

	bool Allocate(uint32_t w, uint32_t h) {
	if (is_valid()) {
	if (buffer_->getWidth() == w && buffer_->getHeight() == h)
	return true;

	if (release_fence_fd_ >= 0) {
	if (sync_wait(release_fence_fd_, -1) != 0) {
	return false;
	}
	}
	Clear();
	}
	buffer_ = new GraphicBuffer(w, h, android::PIXEL_FORMAT_RGBA_8888,
	GRALLOC_USAGE_HW_FB \| GRALLOC_USAGE_HW_RENDER \|
	GRALLOC_USAGE_HW_COMPOSER);
	release_fence_fd_ = -1;
	return is_valid();
	}

	void Clear() {
	if (!is_valid())
	return;

	if (release_fence_fd_ >= 0) {
	close(release_fence_fd_);
	release_fence_fd_ = -1;
	}

	buffer_.clear();
	}

	int WaitReleased(int timeout_milliseconds) {
	if (!is_valid())
	return 0;
	if (release_fence_fd_ < 0)
	return 0;

	int ret = sync_wait(release_fence_fd_, timeout_milliseconds);
	return ret;
	}

	private:
	sp<GraphicBuffer> buffer_;
	int release_fence_fd_;
	};


	typedef struct hwc_drm_display {
	struct hwc_context_t *ctx;
	int display;

	std::vector<uint32_t> config_ids;

	VSyncWorker vsync_worker;

	hwc_drm_display_framebuffer fb_chain[HWC_FB_BUFFERS];
	int fb_idx;
	} hwc_drm_display_t;

	struct hwc_context_t {
	// map of display:hwc_drm_display_t
	typedef std::map<int, hwc_drm_display_t> DisplayMap;
	typedef DisplayMap::iterator DisplayMapIter;

	hwc_context_t() : procs(NULL), importer(NULL) {
	}

	~hwc_context_t() {
	delete importer;
	}

	hwc_composer_device_1_t device;
	hwc_procs_t const *procs;

	DisplayMap displays;
	DrmResources drm;
	Importer *importer;
	GLCompositor pre_compositor;
	};

	static void hwc_dump(struct hwc_composer_device_1* dev, char *buff,
	int buff_len) {
	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;
	std::ostringstream out;

	ctx->drm.compositor()->Dump(&out);
	std::string out_str = out.str();
	strncpy(buff, out_str.c_str(), std::min((size_t)buff_len, out_str.length()));
	}

	static int hwc_prepare(hwc_composer_device_1_t *dev, size_t num_displays,
	hwc_display_contents_1_t **display_contents) {
	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;
	for (int i = 0; i < (int)num_displays; ++i) {
	if (!display_contents[i])
	continue;

	DrmCrtc *crtc = ctx->drm.GetCrtcForDisplay(i);
	if (!crtc) {
	ALOGE("No crtc for display %d", i);
	return -ENODEV;
	}

	int num_layers = display_contents[i]->numHwLayers;
	for (int j = 0; j < num_layers; j++) {
	hwc_layer_1_t *layer = &display_contents[i]->hwLayers[j];

	if (layer->compositionType == HWC_FRAMEBUFFER)
	layer->compositionType = HWC_OVERLAY;
	}
	}

	return 0;
	}

	static void hwc_set_cleanup(size_t num_displays,
	hwc_display_contents_1_t **display_contents,
	Composition *composition) {
	for (int i = 0; i < (int)num_displays; ++i) {
	if (!display_contents[i])
	continue;

	hwc_display_contents_1_t *dc = display_contents[i];
	for (size_t j = 0; j < dc->numHwLayers; ++j) {
	hwc_layer_1_t *layer = &dc->hwLayers[j];
	if (layer->acquireFenceFd >= 0) {
	close(layer->acquireFenceFd);
	layer->acquireFenceFd = -1;
	}
	}
	if (dc->outbufAcquireFenceFd >= 0) {
	close(dc->outbufAcquireFenceFd);
	dc->outbufAcquireFenceFd = -1;
	}
	}

	delete composition;
	}

	static int hwc_add_layer(int display, hwc_context_t ctx, hwc_layer_1_t layer,
	Composition *composition) {
	hwc_drm_bo_t bo;
	int ret = ctx->importer->ImportBuffer(layer->handle, &bo);
	if (ret) {
	ALOGE("Failed to import handle to bo %d", ret);
	return ret;
	}

	ret = composition->AddLayer(display, layer, &bo);
	if (!ret)
	return 0;

	int destroy_ret = ctx->importer->ReleaseBuffer(&bo);
	if (destroy_ret)
	ALOGE("Failed to destroy buffer %d", destroy_ret);

	return ret;
	}

	static int hwc_set(hwc_composer_device_1_t *dev, size_t num_displays,
	hwc_display_contents_1_t **display_contents) {
	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;
	Composition *composition =
	ctx->drm.compositor()->CreateComposition(ctx->importer);
	if (!composition) {
	ALOGE("Drm composition init failed");
	hwc_set_cleanup(num_displays, display_contents, NULL);
	return -EINVAL;
	}

	int ret;
	for (int i = 0; i < (int)num_displays; ++i) {
	if (!display_contents[i])
	continue;

	hwc_display_contents_1_t *dc = display_contents[i];
	int j;
	unsigned num_layers = 0;
	unsigned num_dc_layers = dc->numHwLayers;
	for (j = 0; j < (int)num_dc_layers; ++j) {
	hwc_layer_1_t *layer = &dc->hwLayers[j];
	if (layer->flags & HWC_SKIP_LAYER)
	continue;
	if (layer->compositionType == HWC_OVERLAY)
	num_layers++;
	}

	unsigned num_planes = composition->GetRemainingLayers(i, num_layers);
	bool use_pre_compositor = false;

	if (num_layers > num_planes) {
	use_pre_compositor = true;
	// Reserve one of the planes for the result of the pre compositor.
	num_planes--;
	}

	for (j = 0; num_planes && j < (int)num_dc_layers; ++j) {
	hwc_layer_1_t *layer = &dc->hwLayers[j];
	if (layer->flags & HWC_SKIP_LAYER)
	continue;
	if (layer->compositionType != HWC_OVERLAY)
	continue;

	ret = hwc_add_layer(i, ctx, layer, composition);
	if (ret) {
	ALOGE("Add layer failed %d", ret);
	hwc_set_cleanup(num_displays, display_contents, composition);
	return ret;
	}
	--num_planes;
	}

	int last_comp_layer = j;

	if (use_pre_compositor) {
	hwc_drm_display_t *hd = &ctx->displays[i];
	struct hwc_drm_display_framebuffer *fb = &hd->fb_chain[hd->fb_idx];
	ret = fb->WaitReleased(-1);
	if (ret) {
	ALOGE("Failed to wait for framebuffer %d", ret);
	hwc_set_cleanup(num_displays, display_contents, composition);
	return ret;
	}

	DrmConnector *connector = ctx->drm.GetConnectorForDisplay(i);
	if (!connector) {
	ALOGE("No connector for display %d", i);
	hwc_set_cleanup(num_displays, display_contents, composition);
	return -ENODEV;
	}

	const DrmMode &mode = connector->active_mode();
	if (!fb->Allocate(mode.h_display(), mode.v_display())) {
	ALOGE("Failed to allocate framebuffer with size %dx%d",
	mode.h_display(), mode.v_display());
	hwc_set_cleanup(num_displays, display_contents, composition);
	return -EINVAL;
	}

	sp<GraphicBuffer> fb_buffer = fb->buffer();
	if (fb_buffer == NULL) {
	ALOGE("Framebuffer is NULL");
	hwc_set_cleanup(num_displays, display_contents, composition);
	return -EINVAL;
	}

	Targeting *targeting = ctx->pre_compositor.targeting();
	if (targeting == NULL) {
	ALOGE("Pre-compositor does not support targeting");
	hwc_set_cleanup(num_displays, display_contents, composition);
	return -EINVAL;
	}

	int target = targeting->CreateTarget(fb_buffer);
	targeting->SetTarget(target);

	Composition *pre_composition = ctx->pre_compositor.CreateComposition(ctx->importer);
	if (pre_composition == NULL) {
	ALOGE("Failed to create pre-composition");
	targeting->ForgetTarget(target);
	hwc_set_cleanup(num_displays, display_contents, composition);
	return -EINVAL;
	}

	for (j = last_comp_layer; j < (int)num_dc_layers; ++j) {
	hwc_layer_1_t *layer = &dc->hwLayers[j];
	if (layer->flags & HWC_SKIP_LAYER)
	continue;
	if (layer->compositionType != HWC_OVERLAY)
	continue;
	ret = hwc_add_layer(i, ctx, layer, pre_composition);
	if (ret) {
	ALOGE("Add layer failed %d", ret);
	delete pre_composition;
	targeting->ForgetTarget(target);
	hwc_set_cleanup(num_displays, display_contents, composition);
	return ret;
	}
	}

	ret = ctx->pre_compositor.QueueComposition(pre_composition);
	pre_composition = NULL;

	targeting->ForgetTarget(target);
	if (ret < 0 && ret != -EALREADY) {
	ALOGE("Pre-composition failed %d", ret);
	hwc_set_cleanup(num_displays, display_contents, composition);
	return ret;
	}

	for (j = last_comp_layer; j < (int)num_dc_layers; ++j) {
	hwc_layer_1_t *layer = &dc->hwLayers[j];
	if (layer->flags & HWC_SKIP_LAYER)
	continue;
	if (layer->compositionType != HWC_OVERLAY)
	continue;
	layer->acquireFenceFd = -1;
	}

	hwc_layer_1_t composite_layer;
	hwc_rect_t visible_rect;
	memset(&composite_layer, 0, sizeof(composite_layer));
	memset(&visible_rect, 0, sizeof(visible_rect));

	composite_layer.compositionType = HWC_OVERLAY;
	composite_layer.handle = fb_buffer->getNativeBuffer()->handle;
	composite_layer.sourceCropf.right = composite_layer.displayFrame.right =
	visible_rect.right = fb_buffer->getWidth();
	composite_layer.sourceCropf.bottom = composite_layer.displayFrame.bottom =
	visible_rect.bottom = fb_buffer->getHeight();
	composite_layer.visibleRegionScreen.numRects = 1;
	composite_layer.visibleRegionScreen.rects = &visible_rect;
	composite_layer.acquireFenceFd = ret == -EALREADY ? -1 : ret;
	// A known invalid fd in case AddLayer does not modify this field.
	composite_layer.releaseFenceFd = -1;
	composite_layer.planeAlpha = 0xff;

	ret = hwc_add_layer(i, ctx, &composite_layer, composition);
	if (ret) {
	ALOGE("Add layer failed %d", ret);
	hwc_set_cleanup(num_displays, display_contents, composition);
	return ret;
	}

	fb->set_release_fence_fd(composite_layer.releaseFenceFd);
	hd->fb_idx = (hd->fb_idx + 1) % HWC_FB_BUFFERS;
	}
	}

	ret = ctx->drm.compositor()->QueueComposition(composition);
	if (ret) {
	ALOGE("Failed to queue the composition");
	hwc_set_cleanup(num_displays, display_contents, composition);
	return ret;
	}
	hwc_set_cleanup(num_displays, display_contents, NULL);
	return ret;
	}

	static int hwc_event_control(struct hwc_composer_device_1 *dev, int display,
	int event, int enabled) {
	if (event != HWC_EVENT_VSYNC \|\| (enabled != 0 && enabled != 1))
	return -EINVAL;

	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;
	hwc_drm_display_t *hd = &ctx->displays[display];
	return hd->vsync_worker.VSyncControl(enabled);
	}

	static int hwc_set_power_mode(struct hwc_composer_device_1 *dev, int display,
	int mode) {
	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;

	uint64_t dpmsValue = 0;
	switch (mode) {
	case HWC_POWER_MODE_OFF:
	dpmsValue = DRM_MODE_DPMS_OFF;
	break;

	/* We can't support dozing right now, so go full on */
	case HWC_POWER_MODE_DOZE:
	case HWC_POWER_MODE_DOZE_SUSPEND:
	case HWC_POWER_MODE_NORMAL:
	dpmsValue = DRM_MODE_DPMS_ON;
	break;
	};
	return ctx->drm.SetDpmsMode(display, dpmsValue);
	}

	static int hwc_query(struct hwc_composer_device_1 * /* dev */, int what,
	int *value) {
	switch (what) {
	case HWC_BACKGROUND_LAYER_SUPPORTED:
	value = 0; / TODO: We should do this */
	break;
	case HWC_VSYNC_PERIOD:
	ALOGW("Query for deprecated vsync value, returning 60Hz");
	value = 1000 1000 * 1000 / 60;
	break;
	case HWC_DISPLAY_TYPES_SUPPORTED:
	*value = HWC_DISPLAY_PRIMARY \| HWC_DISPLAY_EXTERNAL;
	break;
	}
	return 0;
	}

	static void hwc_register_procs(struct hwc_composer_device_1 *dev,
	hwc_procs_t const *procs) {
	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;

	ctx->procs = procs;

	for (hwc_context_t::DisplayMapIter iter = ctx->displays.begin();
	iter != ctx->displays.end(); ++iter) {
	iter->second.vsync_worker.SetProcs(procs);
	}
	}

	static int hwc_get_display_configs(struct hwc_composer_device_1 *dev,
	int display, uint32_t *configs,
	size_t *num_configs) {
	if (!*num_configs)
	return 0;

	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;
	hwc_drm_display_t *hd = &ctx->displays[display];
	hd->config_ids.clear();

	DrmConnector *connector = ctx->drm.GetConnectorForDisplay(display);
	if (!connector) {
	ALOGE("Failed to get connector for display %d", display);
	return -ENODEV;
	}

	int ret = connector->UpdateModes();
	if (ret) {
	ALOGE("Failed to update display modes %d", ret);
	return ret;
	}

	for (DrmConnector::ModeIter iter = connector->begin_modes();
	iter != connector->end_modes(); ++iter) {
	size_t idx = hd->config_ids.size();
	if (idx == *num_configs)
	break;
	hd->config_ids.push_back(iter->id());
	configs[idx] = iter->id();
	}
	*num_configs = hd->config_ids.size();
	return *num_configs == 0 ? -1 : 0;
	}

	static int hwc_get_display_attributes(struct hwc_composer_device_1 *dev,
	int display, uint32_t config,
	const uint32_t *attributes,
	int32_t *values) {
	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;
	DrmConnector *c = ctx->drm.GetConnectorForDisplay(display);
	if (!c) {
	ALOGE("Failed to get DrmConnector for display %d", display);
	return -ENODEV;
	}
	DrmMode mode;
	for (DrmConnector::ModeIter iter = c->begin_modes(); iter != c->end_modes();
	++iter) {
	if (iter->id() == config) {
	mode = *iter;
	break;
	}
	}
	if (mode.id() == 0) {
	ALOGE("Failed to find active mode for display %d", display);
	return -ENOENT;
	}

	uint32_t mm_width = c->mm_width();
	uint32_t mm_height = c->mm_height();
	for (int i = 0; attributes[i] != HWC_DISPLAY_NO_ATTRIBUTE; ++i) {
	switch (attributes[i]) {
	case HWC_DISPLAY_VSYNC_PERIOD:
	values[i] = 1000 * 1000 * 1000 / mode.v_refresh();
	break;
	case HWC_DISPLAY_WIDTH:
	values[i] = mode.h_display();
	break;
	case HWC_DISPLAY_HEIGHT:
	values[i] = mode.v_display();
	break;
	case HWC_DISPLAY_DPI_X:
	/* Dots per 1000 inches */
	values[i] = mm_width ? (mode.h_display() * UM_PER_INCH) / mm_width : 0;
	break;
	case HWC_DISPLAY_DPI_Y:
	/* Dots per 1000 inches */
	values[i] =
	mm_height ? (mode.v_display() * UM_PER_INCH) / mm_height : 0;
	break;
	}
	}
	return 0;
	}

	static int hwc_get_active_config(struct hwc_composer_device_1 *dev,
	int display) {
	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;
	DrmConnector *c = ctx->drm.GetConnectorForDisplay(display);
	if (!c) {
	ALOGE("Failed to get DrmConnector for display %d", display);
	return -ENODEV;
	}

	DrmMode mode = c->active_mode();
	hwc_drm_display_t *hd = &ctx->displays[display];
	for (size_t i = 0; i < hd->config_ids.size(); ++i) {
	if (hd->config_ids[i] == mode.id())
	return i;
	}
	return -1;
	}

	static int hwc_set_active_config(struct hwc_composer_device_1 *dev, int display,
	int index) {
	struct hwc_context_t ctx = (struct hwc_context_t )&dev->common;
	hwc_drm_display_t *hd = &ctx->displays[display];
	if (index >= (int)hd->config_ids.size()) {
	ALOGE("Invalid config index %d passed in", index);
	return -EINVAL;
	}

	DrmConnector *c = ctx->drm.GetConnectorForDisplay(display);
	if (!c) {
	ALOGE("Failed to get connector for display %d", display);
	return -ENODEV;
	}
	DrmMode mode;
	for (DrmConnector::ModeIter iter = c->begin_modes(); iter != c->end_modes();
	++iter) {
	if (iter->id() == hd->config_ids[index]) {
	mode = *iter;
	break;
	}
	}
	if (mode.id() != hd->config_ids[index]) {
	ALOGE("Could not find active mode for %d/%d", index, hd->config_ids[index]);
	return -ENOENT;
	}
	int ret = ctx->drm.SetDisplayActiveMode(display, mode);
	if (ret) {
	ALOGE("Failed to set active config %d", ret);
	return ret;
	}
	return ret;
	}

	static int hwc_device_close(struct hw_device_t *dev) {
	struct hwc_context_t ctx = (struct hwc_context_t )dev;
	delete ctx;
	return 0;
	}

	/*
	* TODO: This function sets the active config to the first one in the list. This
	* should be fixed such that it selects the preferred mode for the display, or
	* some other, saner, method of choosing the config.
	*/
	static int hwc_set_initial_config(hwc_drm_display_t *hd) {
	uint32_t config;
	size_t num_configs = 1;
	int ret = hwc_get_display_configs(&hd->ctx->device, hd->display, &config,
	&num_configs);
	if (ret \|\| !num_configs)
	return 0;

	ret = hwc_set_active_config(&hd->ctx->device, hd->display, 0);
	if (ret) {
	ALOGE("Failed to set active config d=%d ret=%d", hd->display, ret);
	return ret;
	}

	return ret;
	}

	static int hwc_initialize_display(struct hwc_context_t *ctx, int display) {
	hwc_drm_display_t *hd = &ctx->displays[display];
	hd->ctx = ctx;
	hd->display = display;
	hd->fb_idx = 0;

	int ret = hwc_set_initial_config(hd);
	if (ret) {
	ALOGE("Failed to set initial config for d=%d ret=%d", display, ret);
	return ret;
	}

	ret = hd->vsync_worker.Init(&ctx->drm, display);
	if (ret) {
	ALOGE("Failed to create event worker for display %d %d\n", display, ret);
	return ret;
	}

	return 0;
	}

	static int hwc_enumerate_displays(struct hwc_context_t *ctx) {
	int ret;
	for (DrmResources::ConnectorIter c = ctx->drm.begin_connectors();
	c != ctx->drm.end_connectors(); ++c) {
	ret = hwc_initialize_display(ctx, (*c)->display());
	if (ret) {
	ALOGE("Failed to initialize display %d", (*c)->display());
	return ret;
	}
	}

	return 0;
	}

	static int hwc_device_open(const struct hw_module_t module, const char name,
	struct hw_device_t **dev) {
	if (strcmp(name, HWC_HARDWARE_COMPOSER)) {
	ALOGE("Invalid module name- %s", name);
	return -EINVAL;
	}

	struct hwc_context_t *ctx = new hwc_context_t();
	if (!ctx) {
	ALOGE("Failed to allocate hwc context");
	return -ENOMEM;
	}

	int ret = ctx->drm.Init();
	if (ret) {
	ALOGE("Can't initialize Drm object %d", ret);
	delete ctx;
	return ret;
	}

	ret = ctx->pre_compositor.Init();
	if (ret) {
	ALOGE("Can't initialize OpenGL Compositor object %d", ret);
	delete ctx;
	return ret;
	}

	ctx->importer = Importer::CreateInstance(&ctx->drm);
	if (!ctx->importer) {
	ALOGE("Failed to create importer instance");
	delete ctx;
	return ret;
	}

	ret = hwc_enumerate_displays(ctx);
	if (ret) {
	ALOGE("Failed to enumerate displays: %s", strerror(ret));
	delete ctx;
	return ret;
	}

	ctx->device.common.tag = HARDWARE_DEVICE_TAG;
	ctx->device.common.version = HWC_DEVICE_API_VERSION_1_4;
	ctx->device.common.module = const_cast<hw_module_t *>(module);
	ctx->device.common.close = hwc_device_close;

	ctx->device.dump = hwc_dump;
	ctx->device.prepare = hwc_prepare;
	ctx->device.set = hwc_set;
	ctx->device.eventControl = hwc_event_control;
	ctx->device.setPowerMode = hwc_set_power_mode;
	ctx->device.query = hwc_query;
	ctx->device.registerProcs = hwc_register_procs;
	ctx->device.getDisplayConfigs = hwc_get_display_configs;
	ctx->device.getDisplayAttributes = hwc_get_display_attributes;
	ctx->device.getActiveConfig = hwc_get_active_config;
	ctx->device.setActiveConfig = hwc_set_active_config;
	ctx->device.setCursorPositionAsync = NULL; /* TODO: Add cursor */

	*dev = &ctx->device.common;

	return 0;
	}
	}

	static struct hw_module_methods_t hwc_module_methods = {
	open : android::hwc_device_open
	};

	hwc_module_t HAL_MODULE_INFO_SYM = {
	common : {
	tag : HARDWARE_MODULE_TAG,
	version_major : 1,
	version_minor : 0,
	id : HWC_HARDWARE_MODULE_ID,
	name : "DRM hwcomposer module",
	author : "The Android Open Source Project",
	methods : &hwc_module_methods,
	dso : NULL,
	reserved : {0},
	}
	};