1 /*
2 * Copyright (c) 2014 - 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 __STRATEGY_INTERFACE_H__
26 #define __STRATEGY_INTERFACE_H__
27 
28 #include <core/sdm_types.h>
29 #include <core/display_interface.h>
30 #include "hw_info_types.h"
31 
32 namespace sdm {
33 
34 struct StrategyConstraints {
35   bool safe_mode = false;   //!< In this mode, strategy manager chooses the composition strategy
36                             //!< that requires minimum number of pipe for the current frame. i.e.,
37                             //!< video only composition, secure only composition or GPU composition
38 
39   bool use_cursor = false;  //!< If this is set, strategy manager will configure cursor layer in the
40                             //!< layer stack as hw cursor else it will be treated as a normal layer
41 
42   uint32_t max_layers = kMaxSDELayers;  //!< Maximum number of layers that shall be programmed
43                                         //!< on hardware for the given layer stack.
44 };
45 
46 class StrategyInterface {
47  public:
48   virtual DisplayError Start(HWLayersInfo *hw_layers_info, uint32_t *max_attempts) = 0;
49   virtual DisplayError GetNextStrategy(StrategyConstraints *constraints) = 0;
50   virtual DisplayError Stop() = 0;
51 
52  protected:
~StrategyInterface()53   virtual ~StrategyInterface() { }
54 };
55 
56 }  // namespace sdm
57 
58 #endif  // __STRATEGY_INTERFACE_H__
59 
60