1 /*
2 * Copyright (c) 2015, The Linux Foundation. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are permitted
5 * provided that the following conditions are met:
6 *    * Redistributions of source code must retain the above copyright notice, this list of
7 *      conditions and the following disclaimer.
8 *    * Redistributions in binary form must reproduce the above copyright notice, this list of
9 *      conditions and the following disclaimer in the documentation and/or other materials provided
10 *      with the distribution.
11 *    * Neither the name of The Linux Foundation nor the names of its contributors may be used to
12 *      endorse or promote products derived from this software without specific prior written
13 *      permission.
14 *
15 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
19 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24 
25 #ifndef __PARTIAL_UPDATE_INTERFACE_H__
26 #define __PARTIAL_UPDATE_INTERFACE_H__
27 
28 #include <core/display_interface.h>
29 #include <core/buffer_allocator.h>
30 #include <core/buffer_sync_handler.h>
31 
32 #include "hw_info_types.h"
33 
34 namespace sdm {
35 
36 struct PUConstraints {
37   bool enable = true;             //!< If this is set, PU will be enabled or it will be disabled
38   bool enable_cursor_pu = false;  //!< If this is set, PU will consider cursor layer in the layer
39                                    //!< stack for cursor partial update
40 };
41 
42 class PartialUpdateInterface {
43  public:
44   virtual DisplayError Start(const PUConstraints &pu_constraints) = 0;
45   virtual DisplayError GenerateROI(HWLayersInfo *hw_layers_info) = 0;
46   virtual DisplayError Stop() = 0;
47 
48  protected:
~PartialUpdateInterface()49   virtual ~PartialUpdateInterface() { }
50 };
51 
52 }  // namespace sdm
53 
54 #endif  // __PARTIAL_UPDATE_INTERFACE_H__
55 
56