contrib/opencsd/decoder/include/mem_acc/trc_mem_acc_cb_if.h

   1 /*!
   2  * \file       trc_mem_acc_cb_if.h
   3  * \brief      OpenCSD : Memory Accessor Callback Direct Interface
   4  *
   5  * \copyright  Copyright (c) 2015, ARM Limited. All Rights Reserved.
   6  */
   7
   8 /*
   9  * Redistribution and use in source and binary forms, with or without modification,
  10  * are permitted provided that the following conditions are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright notice,
  13  * this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright notice,
  16  * this list of conditions and the following disclaimer in the documentation
  17  * and/or other materials provided with the distribution.
  18  *
  19  * 3. Neither the name of the copyright holder nor the names of its contributors
  20  * may be used to endorse or promote products derived from this software without
  21  * specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  26  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  27  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef ARM_TRC_MEM_ACC_CB_IF_H_INCLUDED
  36 #define ARM_TRC_MEM_ACC_CB_IF_H_INCLUDED
  37
  38 #include "opencsd/ocsd_if_types.h"
  39
  40 /*!
  41  * @class TrcMemAccCBIF
  42  * @brief Interface class to implement memory accessor callbacks
  43  *
  44  *  Implement an object with this interface to use in a memory accessor callback type.
  45  *  Callback accesses the memory according to address and memory space.
  46  *  Use for trace decode memory access on live systems, or where the implemented accessor types
  47  *  are not suitable for the memory data being accessed.
  48  *
  49  */
  50 class TrcMemAccCBIF
  51 {
  52 public:
  53     TrcMemAccCBIF() {};
  54     virtual ~TrcMemAccCBIF() {};
  55
  56     /*!
  57      * Read bytes from via the accessor from the memory range.
  58      *
  59      * @param s_address : Start address of the read.
  60      * @param memSpace  : memory space for this access.
  61      * @param reqBytes : Number of bytes required.
  62      * @param *byteBuffer : Buffer to copy the bytes into.
  63      *
  64      * @return uint32_t : Number of bytes read, 0 if s_address out of range, or mem space not accessible.
  65      */
  66     virtual const uint32_t readBytes(const ocsd_vaddr_t s_address, const ocsd_mem_space_acc_t memSpace, const uint32_t reqBytes, uint8_t *byteBuffer) = 0;
  67 };
  68
  69 #endif // ARM_TRC_MEM_ACC_CB_IF_H_INCLUDED
  70
  71 /* End of File trc_mem_acc_cb_if.h */