1 /*
2  * Copyright (c) 2016-2017, 2019-2020 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 <utils/locker.h>
36 #include <hardware/hwcomposer2.h>
37 #undef HWC2_INCLUDE_STRINGIFICATION
38 #undef HWC2_USE_CPP11
39 
40 namespace sdm {
41 
42 class HWCCallbacks {
43  public:
44   static const int kNumBuiltIn = 4;
45   static const int kNumPluggable = 4;
46   static const int kNumVirtual = 4;
47   // Add 1 primary display which can be either a builtin or pluggable.
48   // Async powermode update requires dummy hwc displays.
49   // Limit dummy displays to builtin/pluggable type for now.
50   static const int kNumRealDisplays = 1 + kNumBuiltIn + kNumPluggable + kNumVirtual;
51   static const int kNumDisplays = 1 + kNumBuiltIn + kNumPluggable + kNumVirtual +
52                                     1 + kNumBuiltIn + kNumPluggable;
53 
54   HWC2::Error Hotplug(hwc2_display_t display, HWC2::Connection state);
55   HWC2::Error Refresh(hwc2_display_t display);
56   HWC2::Error Vsync(hwc2_display_t display, int64_t timestamp);
57   HWC2::Error Vsync_2_4(hwc2_display_t display, int64_t timestamp, uint32_t period);
58   HWC2::Error VsyncPeriodTimingChanged(hwc2_display_t display,
59                                        hwc_vsync_period_change_timeline_t *updated_timeline);
60   HWC2::Error SeamlessPossible(hwc2_display_t display);
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_data_ != 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)); }
IsClientConnected()72   bool IsClientConnected() {
73     SCOPE_LOCK(hotplug_lock_);
74     return client_connected_;
75   }
76 
77  private:
78   hwc2_callback_data_t hotplug_data_ = nullptr;
79   hwc2_callback_data_t refresh_data_ = nullptr;
80   hwc2_callback_data_t vsync_data_ = nullptr;
81   hwc2_callback_data_t vsync_2_4_data_ = nullptr;
82   hwc2_callback_data_t vsync_period_timing_changed_data_ = nullptr;
83   hwc2_callback_data_t seamless_possible_data_ = nullptr;
84 
85   HWC2_PFN_HOTPLUG hotplug_ = nullptr;
86   HWC2_PFN_REFRESH refresh_ = nullptr;
87   HWC2_PFN_VSYNC vsync_ = nullptr;
88   HWC2_PFN_VSYNC_2_4 vsync_2_4_ = nullptr;
89   HWC2_PFN_VSYNC_PERIOD_TIMING_CHANGED vsync_period_timing_changed_ = nullptr;
90   HWC2_PFN_SEAMLESS_POSSIBLE seamless_possible_ = nullptr;
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   Locker hotplug_lock_;
96   Locker refresh_lock_;
97   Locker vsync_lock_;
98   Locker vsync_2_4_lock_;
99   Locker vsync_period_timing_changed_lock_;
100   Locker seamless_possible_lock_;
101   bool client_connected_ = false;
102 };
103 
104 }  // namespace sdm
105 
106 #endif  // __HWC_CALLBACKS_H__
107