117f65170SRuslan Bukin /*!
217f65170SRuslan Bukin * \file trc_mem_acc_base.h
317f65170SRuslan Bukin * \brief OpenCSD : Memory accessor base class.
417f65170SRuslan Bukin *
517f65170SRuslan Bukin * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved.
617f65170SRuslan Bukin */
717f65170SRuslan Bukin
817f65170SRuslan Bukin /*
917f65170SRuslan Bukin * Redistribution and use in source and binary forms, with or without modification,
1017f65170SRuslan Bukin * are permitted provided that the following conditions are met:
1117f65170SRuslan Bukin *
1217f65170SRuslan Bukin * 1. Redistributions of source code must retain the above copyright notice,
1317f65170SRuslan Bukin * this list of conditions and the following disclaimer.
1417f65170SRuslan Bukin *
1517f65170SRuslan Bukin * 2. Redistributions in binary form must reproduce the above copyright notice,
1617f65170SRuslan Bukin * this list of conditions and the following disclaimer in the documentation
1717f65170SRuslan Bukin * and/or other materials provided with the distribution.
1817f65170SRuslan Bukin *
1917f65170SRuslan Bukin * 3. Neither the name of the copyright holder nor the names of its contributors
2017f65170SRuslan Bukin * may be used to endorse or promote products derived from this software without
2117f65170SRuslan Bukin * specific prior written permission.
2217f65170SRuslan Bukin *
2317f65170SRuslan Bukin * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
2417f65170SRuslan Bukin * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
2517f65170SRuslan Bukin * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
2617f65170SRuslan Bukin * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
2717f65170SRuslan Bukin * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
2817f65170SRuslan Bukin * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
2917f65170SRuslan Bukin * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
3017f65170SRuslan Bukin * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
3117f65170SRuslan Bukin * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
3217f65170SRuslan Bukin * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3317f65170SRuslan Bukin */
3417f65170SRuslan Bukin
3517f65170SRuslan Bukin #ifndef ARM_TRC_MEM_ACC_BASE_H_INCLUDED
3617f65170SRuslan Bukin #define ARM_TRC_MEM_ACC_BASE_H_INCLUDED
3717f65170SRuslan Bukin
3817f65170SRuslan Bukin #include "opencsd/ocsd_if_types.h"
3917f65170SRuslan Bukin #include <string>
4017f65170SRuslan Bukin
4117f65170SRuslan Bukin /*!
4217f65170SRuslan Bukin * @class TrcMemAccessorBase
4317f65170SRuslan Bukin * @brief Memory range to access by trace decoder.
4417f65170SRuslan Bukin *
4517f65170SRuslan Bukin * Represents a memory access range for the trace decoder.
4617f65170SRuslan Bukin * Range inclusive from m_startAddress to m_endAddress.
4717f65170SRuslan Bukin * e.g. a 1k range from 0x1000 has start of 0x1000 and end of 0x13FF
4817f65170SRuslan Bukin *
4917f65170SRuslan Bukin * Derived classes provide specific access types such as binary files and memory buffers.
5017f65170SRuslan Bukin *
5117f65170SRuslan Bukin */
5217f65170SRuslan Bukin class TrcMemAccessorBase
5317f65170SRuslan Bukin {
5417f65170SRuslan Bukin public:
5517f65170SRuslan Bukin
5617f65170SRuslan Bukin /** Describes the storage type of the underlying memory accessor */
5717f65170SRuslan Bukin enum MemAccTypes {
5817f65170SRuslan Bukin MEMACC_UNKNOWN,
5917f65170SRuslan Bukin MEMACC_FILE, //<! Binary data file accessor
6017f65170SRuslan Bukin MEMACC_BUFPTR, //<! memory buffer accessor
6117f65170SRuslan Bukin MEMACC_CB_IF, //<! callback interface accessor - use for live memory access
6217f65170SRuslan Bukin };
6317f65170SRuslan Bukin
6417f65170SRuslan Bukin /** default constructor */
6517f65170SRuslan Bukin TrcMemAccessorBase(MemAccTypes type);
6617f65170SRuslan Bukin
6717f65170SRuslan Bukin /** costruct with address range values */
6817f65170SRuslan Bukin TrcMemAccessorBase(MemAccTypes type, ocsd_vaddr_t startAddr, ocsd_vaddr_t endAddr);
6917f65170SRuslan Bukin
7017f65170SRuslan Bukin /** default desctructor */
~TrcMemAccessorBase()7117f65170SRuslan Bukin virtual ~TrcMemAccessorBase() {};
7217f65170SRuslan Bukin
7317f65170SRuslan Bukin /*!
7417f65170SRuslan Bukin * Set the inclusive address range of this accessor.
7517f65170SRuslan Bukin *
7617f65170SRuslan Bukin * @param startAddr : start address of the range.
7717f65170SRuslan Bukin * @param endAddr : end address of the range.
7817f65170SRuslan Bukin */
7917f65170SRuslan Bukin void setRange(ocsd_vaddr_t startAddr, ocsd_vaddr_t endAddr);
8017f65170SRuslan Bukin
8117f65170SRuslan Bukin /*!
8217f65170SRuslan Bukin * test if an address is in the inclusive range for this accessor
8317f65170SRuslan Bukin *
8417f65170SRuslan Bukin * @param s_address : Address to test.
8517f65170SRuslan Bukin *
8617f65170SRuslan Bukin * @return const bool : true if the address is in range.
8717f65170SRuslan Bukin */
8817f65170SRuslan Bukin virtual const bool addrInRange(const ocsd_vaddr_t s_address) const;
8917f65170SRuslan Bukin
9017f65170SRuslan Bukin
9117f65170SRuslan Bukin /*!
9217f65170SRuslan Bukin * test if an address is the start of range for this accessor
9317f65170SRuslan Bukin *
9417f65170SRuslan Bukin * @param s_address : Address to test.
9517f65170SRuslan Bukin *
9617f65170SRuslan Bukin * @return const bool : true if the address is start of range.
9717f65170SRuslan Bukin */
9817f65170SRuslan Bukin virtual const bool addrStartOfRange(const ocsd_vaddr_t s_address) const;
9917f65170SRuslan Bukin
10017f65170SRuslan Bukin /*!
10117f65170SRuslan Bukin * Test number of bytes available from the start address, up to the number of requested bytes.
10217f65170SRuslan Bukin * Tests if all the requested bytes are available from the supplied start address.
10317f65170SRuslan Bukin * Returns the number available up to full requested amount.
10417f65170SRuslan Bukin *
10517f65170SRuslan Bukin * @param s_address : Start address within the range.
10617f65170SRuslan Bukin * @param reqBytes : Number of bytes needed from the start address.
10717f65170SRuslan Bukin *
10817f65170SRuslan Bukin * @return const uint32_t : Bytes available, up to reqBytes. 0 is s_address not in range.
10917f65170SRuslan Bukin */
11017f65170SRuslan Bukin virtual const uint32_t bytesInRange(const ocsd_vaddr_t s_address, const uint32_t reqBytes) const;
11117f65170SRuslan Bukin
11217f65170SRuslan Bukin /*!
11317f65170SRuslan Bukin * test is supplied range accessor overlaps this range.
11417f65170SRuslan Bukin *
11517f65170SRuslan Bukin * @param *p_test_acc : Accessor to test for overlap.
11617f65170SRuslan Bukin *
11717f65170SRuslan Bukin * @return bool : true if overlap, false if not.
11817f65170SRuslan Bukin */
11917f65170SRuslan Bukin virtual const bool overLapRange(const TrcMemAccessorBase *p_test_acc) const;
12017f65170SRuslan Bukin
12117f65170SRuslan Bukin /*!
12217f65170SRuslan Bukin * Read bytes from via the accessor from the memory range.
12317f65170SRuslan Bukin *
12417f65170SRuslan Bukin * @param s_address : Start address of the read.
12517f65170SRuslan Bukin * @param memSpace : memory space for this access.
126fc502085SRuslan Bukin * @param trcID : Trace ID of trace source.
12717f65170SRuslan Bukin * @param reqBytes : Number of bytes required.
12817f65170SRuslan Bukin * @param *byteBuffer : Buffer to copy the bytes into.
12917f65170SRuslan Bukin *
13017f65170SRuslan Bukin * @return uint32_t : Number of bytes read, 0 if s_address out of range, or mem space not accessible.
13117f65170SRuslan Bukin */
132fc502085SRuslan Bukin virtual const uint32_t readBytes(const ocsd_vaddr_t s_address, const ocsd_mem_space_acc_t memSpace, const uint8_t trcID, const uint32_t reqBytes, uint8_t *byteBuffer) = 0;
13317f65170SRuslan Bukin
13417f65170SRuslan Bukin /*!
13517f65170SRuslan Bukin * Validate the address range - ensure addresses aligned, different, st < en etc.
13617f65170SRuslan Bukin *
13717f65170SRuslan Bukin * @return bool : true if valid range.
13817f65170SRuslan Bukin */
13917f65170SRuslan Bukin virtual const bool validateRange();
14017f65170SRuslan Bukin
14117f65170SRuslan Bukin
getType()14217f65170SRuslan Bukin const enum MemAccTypes getType() const { return m_type; };
14317f65170SRuslan Bukin
14417f65170SRuslan Bukin /* handle memory spaces */
setMemSpace(ocsd_mem_space_acc_t memSpace)14517f65170SRuslan Bukin void setMemSpace(ocsd_mem_space_acc_t memSpace) { m_mem_space = memSpace; };
getMemSpace()14617f65170SRuslan Bukin const ocsd_mem_space_acc_t getMemSpace() const { return m_mem_space; };
inMemSpace(const ocsd_mem_space_acc_t mem_space)14717f65170SRuslan Bukin const bool inMemSpace(const ocsd_mem_space_acc_t mem_space) const { return (bool)(((uint8_t)m_mem_space & (uint8_t)mem_space) != 0); };
14817f65170SRuslan Bukin
14917f65170SRuslan Bukin /* memory access info logging */
15017f65170SRuslan Bukin virtual void getMemAccString(std::string &accStr) const;
15117f65170SRuslan Bukin
15217f65170SRuslan Bukin protected:
15317f65170SRuslan Bukin ocsd_vaddr_t m_startAddress; /**< accessible range start address */
15417f65170SRuslan Bukin ocsd_vaddr_t m_endAddress; /**< accessible range end address */
15517f65170SRuslan Bukin const MemAccTypes m_type; /**< memory accessor type */
15617f65170SRuslan Bukin ocsd_mem_space_acc_t m_mem_space;
15717f65170SRuslan Bukin };
15817f65170SRuslan Bukin
TrcMemAccessorBase(MemAccTypes accType,ocsd_vaddr_t startAddr,ocsd_vaddr_t endAddr)15917f65170SRuslan Bukin inline TrcMemAccessorBase::TrcMemAccessorBase(MemAccTypes accType, ocsd_vaddr_t startAddr, ocsd_vaddr_t endAddr) :
16017f65170SRuslan Bukin m_startAddress(startAddr),
16117f65170SRuslan Bukin m_endAddress(endAddr),
16217f65170SRuslan Bukin m_type(accType),
16317f65170SRuslan Bukin m_mem_space(OCSD_MEM_SPACE_ANY)
16417f65170SRuslan Bukin {
16517f65170SRuslan Bukin }
16617f65170SRuslan Bukin
TrcMemAccessorBase(MemAccTypes accType)16717f65170SRuslan Bukin inline TrcMemAccessorBase::TrcMemAccessorBase(MemAccTypes accType) :
16817f65170SRuslan Bukin m_startAddress(0),
16917f65170SRuslan Bukin m_endAddress(0),
17017f65170SRuslan Bukin m_type(accType),
17117f65170SRuslan Bukin m_mem_space(OCSD_MEM_SPACE_ANY)
17217f65170SRuslan Bukin {
17317f65170SRuslan Bukin }
17417f65170SRuslan Bukin
setRange(ocsd_vaddr_t startAddr,ocsd_vaddr_t endAddr)17517f65170SRuslan Bukin inline void TrcMemAccessorBase::setRange(ocsd_vaddr_t startAddr, ocsd_vaddr_t endAddr)
17617f65170SRuslan Bukin {
17717f65170SRuslan Bukin m_startAddress = startAddr;
17817f65170SRuslan Bukin m_endAddress = endAddr;
17917f65170SRuslan Bukin }
18017f65170SRuslan Bukin
addrInRange(const ocsd_vaddr_t s_address)18117f65170SRuslan Bukin inline const bool TrcMemAccessorBase::addrInRange(const ocsd_vaddr_t s_address) const
18217f65170SRuslan Bukin {
18317f65170SRuslan Bukin return (s_address >= m_startAddress) && (s_address <= m_endAddress);
18417f65170SRuslan Bukin }
18517f65170SRuslan Bukin
addrStartOfRange(const ocsd_vaddr_t s_address)18617f65170SRuslan Bukin inline const bool TrcMemAccessorBase::addrStartOfRange(const ocsd_vaddr_t s_address) const
18717f65170SRuslan Bukin {
18817f65170SRuslan Bukin return (s_address == m_startAddress);
18917f65170SRuslan Bukin }
19017f65170SRuslan Bukin
19117f65170SRuslan Bukin
bytesInRange(const ocsd_vaddr_t s_address,const uint32_t reqBytes)19217f65170SRuslan Bukin inline const uint32_t TrcMemAccessorBase::bytesInRange(const ocsd_vaddr_t s_address, const uint32_t reqBytes) const
19317f65170SRuslan Bukin {
19417f65170SRuslan Bukin ocsd_vaddr_t bytesInRange = 0;
19517f65170SRuslan Bukin if(addrInRange(s_address)) // start not in range, return 0.
19617f65170SRuslan Bukin {
19717f65170SRuslan Bukin // bytes available till end address.
19817f65170SRuslan Bukin bytesInRange = m_endAddress - s_address + 1;
19917f65170SRuslan Bukin if(bytesInRange > reqBytes)
20017f65170SRuslan Bukin bytesInRange = reqBytes;
20117f65170SRuslan Bukin }
20217f65170SRuslan Bukin return (uint32_t)bytesInRange;
20317f65170SRuslan Bukin }
20417f65170SRuslan Bukin
overLapRange(const TrcMemAccessorBase * p_test_acc)20517f65170SRuslan Bukin inline const bool TrcMemAccessorBase::overLapRange(const TrcMemAccessorBase *p_test_acc) const
20617f65170SRuslan Bukin {
20717f65170SRuslan Bukin if( addrInRange(p_test_acc->m_startAddress) ||
20817f65170SRuslan Bukin addrInRange(p_test_acc->m_endAddress)
20917f65170SRuslan Bukin )
21017f65170SRuslan Bukin return true;
21117f65170SRuslan Bukin return false;
21217f65170SRuslan Bukin }
21317f65170SRuslan Bukin
validateRange()21417f65170SRuslan Bukin inline const bool TrcMemAccessorBase::validateRange()
21517f65170SRuslan Bukin {
21617f65170SRuslan Bukin if(m_startAddress & 0x1) // at least hword aligned for thumb
21717f65170SRuslan Bukin return false;
21817f65170SRuslan Bukin if((m_endAddress + 1) & 0x1)
21917f65170SRuslan Bukin return false;
22017f65170SRuslan Bukin if(m_startAddress == m_endAddress) // zero length range.
22117f65170SRuslan Bukin return false;
22217f65170SRuslan Bukin if(m_startAddress > m_endAddress) // values bakcwards / invalid
22317f65170SRuslan Bukin return false;
22417f65170SRuslan Bukin return true;
22517f65170SRuslan Bukin }
22617f65170SRuslan Bukin
22717f65170SRuslan Bukin
22817f65170SRuslan Bukin class TrcMemAccFactory
22917f65170SRuslan Bukin {
23017f65170SRuslan Bukin public:
23117f65170SRuslan Bukin /** Accessor Creation */
23217f65170SRuslan Bukin static ocsd_err_t CreateBufferAccessor(TrcMemAccessorBase **pAccessor, const ocsd_vaddr_t s_address, const uint8_t *p_buffer, const uint32_t size);
23317f65170SRuslan Bukin static ocsd_err_t CreateFileAccessor(TrcMemAccessorBase **pAccessor, const std::string &pathToFile, ocsd_vaddr_t startAddr, size_t offset = 0, size_t size = 0);
23417f65170SRuslan Bukin static ocsd_err_t CreateCBAccessor(TrcMemAccessorBase **pAccessor, const ocsd_vaddr_t s_address, const ocsd_vaddr_t e_address, const ocsd_mem_space_acc_t mem_space);
23517f65170SRuslan Bukin
23617f65170SRuslan Bukin /** Accessor Destruction */
23717f65170SRuslan Bukin static void DestroyAccessor(TrcMemAccessorBase *pAccessor);
23817f65170SRuslan Bukin private:
TrcMemAccFactory()23917f65170SRuslan Bukin TrcMemAccFactory() {};
~TrcMemAccFactory()24017f65170SRuslan Bukin ~TrcMemAccFactory() {};
24117f65170SRuslan Bukin };
24217f65170SRuslan Bukin
24317f65170SRuslan Bukin #endif // ARM_TRC_MEM_ACC_BASE_H_INCLUDED
24417f65170SRuslan Bukin
24517f65170SRuslan Bukin /* End of File trc_mem_acc_base.h */
246