summaryrefslogtreecommitdiffstats
path: root/src/include/usr/isteps/pm/occAccess.H
blob: a5b46ff45f86a3132ebdd802fdf6457d94ab70b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/isteps/pm/occAccess.H $                       */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2014,2017                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef OCCACCESS_H_
#define OCCACCESS_H_

#include <config.h>
#include <errl/errlentry.H>
#include <targeting/common/commontargeting.H>

namespace HBOCC
{
    /**
     * @brief Read OCC SRAM
     *
     * @param[in]     i_pTarget   PROC or OCC target pointer
     * @param[in]     i_addr      OCI Address to be used for the operation
     * @param[in,out] io_dataBuf  Reference to data buffer
     * @param[in]     i_dataLen   Size of the data to read
     * @return errlHndl_t   Error log if operation failed
     */
    errlHndl_t readSRAM(const TARGETING::Target*i_pTarget,
                        const uint32_t i_addr,
                        uint64_t * io_dataBuf,
                        size_t i_dataLen );

    /**
     * @brief Write OCC SRAM
     *
     * @param[in]     i_pTarget   PROC or OCC target pointer
     * @param[in]     i_addr      OCI Address to be used for the operation
     * @param[in]     i_dataBuf   Reference to data buffer
     * @param[in]     i_dataLen   Size of the data to write
     * @return errlHndl_t   Error log if operation failed
     */
    errlHndl_t writeSRAM(const TARGETING::Target*i_pTarget,
                         const uint32_t i_addr,
                         uint64_t * io_dataBuf,
                         size_t i_dataLen );

    /**
     * @brief Write OCC Circular Buffer
     *
     * @param[in]     i_pTarget   PROC or OCC target pointer
     * @param[in]     i_dataBuf   Reference to data buffer
     * @return errlHndl_t   Error log if operation failed
     */
    errlHndl_t writeCircularBuffer(const TARGETING::Target*i_pTarget,
                                   uint64_t * i_dataBuf);

} //end OCC namespace

#endif
OpenPOWER on IntegriCloud