/*
 * Copyright © 2014 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * Authors:
 *	Midhun Kodiyath <midhunchandra.kodiyath@intel.com>
 */

#ifndef CM_SURFACE_2D_BASE_H_
#define CM_SURFACE_2D_BASE_H_

class CmSurface2D {
 public:
        virtual INT GetIndex(SurfaceIndex * &pIndex) = 0;
        virtual INT SetSurfaceStateDimensions(UINT iWidth, UINT iHeight,
                                      SurfaceIndex * pSurfIndex = NULL) = 0;

        /* The following Read/Write of 2D surface is not required as when it is
         * shared between Cm and other component.
         */

        virtual INT ReadSurface(unsigned char *pSysMem, CmEvent * pEvent,
                        UINT64 sysMemSize = 0xFFFFFFFFFFFFFFFFULL) = 0;
        virtual INT WriteSurface(const unsigned char *pSysMem, CmEvent * pEvent,
                         UINT64 sysMemSize = 0xFFFFFFFFFFFFFFFFULL) = 0;
        virtual INT ReadSurfaceStride(unsigned char *pSysMem, CmEvent * pEvent,
                              const UINT stride, UINT64 sysMemSize =
                              0xFFFFFFFFFFFFFFFFULL) = 0;
        virtual INT WriteSurfaceStride(const unsigned char *pSysMem, CmEvent * pEvent,
                               const UINT stride, UINT64 sysMemSize =
                               0xFFFFFFFFFFFFFFFFULL) = 0;
};

#endif /*CM_SURFACE_2D_BASE_H_*/
