1 /* 2 * Copyright (c) 2015, 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 /*! @file blit_engine.h 31 @brief Interface file for Blit based compositior. 32 33 @details The client can use this interface to get the blit composition done 34 35 */ 36 37 #ifndef __BLIT_ENGINE_H__ 38 #define __BLIT_ENGINE_H__ 39 40 namespace sdm { 41 42 /*! @brief Blit Engine implemented by the client 43 44 @details This class declares prototype for BlitEngine Interface which must be 45 implemented by the client. HWC will use this interface to use a Blit engine to get the 46 composition done. 47 48 */ 49 class BlitEngine { 50 public: BlitEngine()51 BlitEngine() { } ~BlitEngine()52 virtual ~BlitEngine() { } 53 54 virtual int Init() = 0; 55 virtual void DeInit() = 0; 56 virtual int Prepare(LayerStack *layer_stack) = 0; 57 virtual int PreCommit(hwc_display_contents_1_t *content_list, LayerStack *layer_stack) = 0; 58 virtual int Commit(hwc_display_contents_1_t *content_list, LayerStack *layer_stack) = 0; 59 virtual void PostCommit(LayerStack *layer_stack) = 0; 60 virtual bool BlitActive() = 0; 61 virtual void SetFrameDumpConfig(uint32_t count) = 0; 62 }; 63 64 } // namespace sdm 65 66 #endif // __BLIT_ENGINE_H__ 67