1 /*
2  * Copyright (c) 2016-2017, 2019 The Linux Foundation. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *    * Redistributions of source code must retain the above copyright
8  *      notice, this list of conditions and the following disclaimer.
9  *    * Redistributions in binary form must reproduce the above
10  *      copyright notice, this list of conditions and the following
11  *      disclaimer in the documentation and/or other materials provided
12  *      with the distribution.
13  *    * Neither the name of The Linux Foundation. nor the names of its
14  *      contributors may be used to endorse or promote products derived
15  *      from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef __HWC_CALLBACKS_H__
31 #define __HWC_CALLBACKS_H__
32 
33 #define HWC2_INCLUDE_STRINGIFICATION
34 #define HWC2_USE_CPP11
35 #include <hardware/hwcomposer2.h>
36 #undef HWC2_INCLUDE_STRINGIFICATION
37 #undef HWC2_USE_CPP11
38 
39 #include <mutex>
40 
41 namespace sdm {
42 
43 class HWCCallbacks {
44  public:
45   static const int kNumBuiltIn = 4;
46   static const int kNumPluggable = 4;
47   static const int kNumVirtual = 4;
48   // Add 1 primary display which can be either a builtin or pluggable.
49   // Async powermode update requires dummy hwc displays.
50   // Limit dummy displays to builtin/pluggable type for now.
51   static const int kNumRealDisplays = 1 + kNumBuiltIn + kNumPluggable + kNumVirtual;
52   static const int kNumDisplays = 1 + kNumBuiltIn + kNumPluggable + kNumVirtual +
53                                     1 + kNumBuiltIn + kNumPluggable;
54 
55   HWC2::Error Hotplug(hwc2_display_t display, HWC2::Connection state);
56   HWC2::Error Refresh(hwc2_display_t display);
57   HWC2::Error Vsync(hwc2_display_t display, int64_t timestamp);
58   HWC2::Error Vsync_2_4(hwc2_display_t display, int64_t timestamp, uint32_t period);
59   HWC2::Error VsyncPeriodTimingChanged(hwc2_display_t display,
60                                        hwc_vsync_period_change_timeline_t *updated_timeline);
61   HWC2::Error Register(HWC2::Callback, hwc2_callback_data_t callback_data,
62                        hwc2_function_pointer_t pointer);
UpdateVsyncSource(hwc2_display_t from)63   void UpdateVsyncSource(hwc2_display_t from) {
64     vsync_source_ = from;
65   }
GetVsyncSource()66   hwc2_display_t GetVsyncSource() { return vsync_source_; }
67 
VsyncCallbackRegistered()68   bool VsyncCallbackRegistered() { return (vsync_ != nullptr); }
Vsync_2_4CallbackRegistered()69   bool Vsync_2_4CallbackRegistered() { return (vsync_2_4_ != nullptr); }
NeedsRefresh(hwc2_display_t display)70   bool NeedsRefresh(hwc2_display_t display) { return pending_refresh_.test(UINT32(display)); }
ResetRefresh(hwc2_display_t display)71   void ResetRefresh(hwc2_display_t display) { pending_refresh_.reset(UINT32(display)); }
72 
73  private:
74   hwc2_callback_data_t hotplug_data_ = nullptr;
75   hwc2_callback_data_t refresh_data_ = nullptr;
76   hwc2_callback_data_t vsync_data_ = nullptr;
77   hwc2_callback_data_t vsync_2_4_data_ = nullptr;
78   hwc2_callback_data_t vsync_period_timing_changed_data_ = nullptr;
79 
80   HWC2_PFN_HOTPLUG hotplug_ = nullptr;
81   HWC2_PFN_REFRESH refresh_ = nullptr;
82   HWC2_PFN_VSYNC vsync_ = nullptr;
83   HWC2_PFN_VSYNC_2_4 vsync_2_4_ = nullptr;
84   HWC2_PFN_VSYNC_PERIOD_TIMING_CHANGED vsync_period_timing_changed_ = nullptr;
85 
86   std::mutex hotplug_mutex_;
87   std::mutex refresh_mutex_;
88   std::mutex vsync_mutex_;
89   std::mutex vsync_2_4_mutex_;
90   std::mutex vsync_period_timing_changed_mutex_;
91 
92   hwc2_display_t vsync_source_ = HWC_DISPLAY_PRIMARY;   // hw vsync is active on this display
93   std::bitset<kNumDisplays> pending_refresh_;         // Displays waiting to get refreshed
94 };
95 
96 }  // namespace sdm
97 
98 #endif  // __HWC_CALLBACKS_H__
99