summaryrefslogtreecommitdiffstats
path: root/src/include/usr/runtime/tceif.H
blob: 6300d91389af672c42996144c3d350bb42e0843c (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
75
76
77
78
79
80
81
82
83
84
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/runtime/tceif.H $                             */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2013,2014              */
/*                                                                        */
/* p1                                                                     */
/*                                                                        */
/* Object Code Only (OCO) source materials                                */
/* Licensed Internal Code Source Materials                                */
/* IBM HostBoot Licensed Internal Code                                    */
/*                                                                        */
/* The source code for this program is not published or otherwise         */
/* divested of its trade secrets, irrespective of what has been           */
/* deposited with the U.S. Copyright Office.                              */
/*                                                                        */
/* Origin: 30                                                             */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef __TCEIF_H
#define __TCEIF_H

#include <stdint.h>
#include <builtins.h>
#include <errl/errlentry.H>
#include <devicefw/userif.H>

#define TCE_TRACE_NAME "TCE"

namespace TCE
{
    /**
     * @brief Responsible for initalizing the TCE entries
     *
     * @return errl - Return Error Handle if failed.
     *
     */
    errlHndl_t createTceTable();

    /**
     * @brief Responsible for setting up the Processors to point to the TCE
     *            table
     *
     * @return errl - Return Error Handle if failed.
     *
     */
    errlHndl_t initTceInHdw();

    /**
     * @brief Responsible for allocating TCE Entries
     *
     * @param[in] i_startingAddress - Starting address to TCE
     * @param[in] i_size - Size of the address space
     * @param[out] startingToken - Starting Entry into the table.
     *          (this is an offset into the array based on the
     *           TCE index * PAGESIZE.  Each TCE entry maps to a
     *           pagesize of memory)
     *
     * Note:  Must run createTceTable and InitTceInHdw or allocate will not work
     *
     * @return errl - Return Error Handle if failed.
     *
     */
    errlHndl_t allocateTces(uint64_t startingAddress, uint64_t size, uint64_t&
                            startingToken);

    /**
     * @brief Responsible for deallocating TCE Entries
     *
     * @param[in] i_startingToken - Token indicating the starting entry to
     *                              remove
     * @param[in] i_size - Size of memory space to remove TCE entries
     *                     associated
     *
     * @return errl - Return Error Handle if fatal failure occurred.
     *
     */
    errlHndl_t deallocateTces(uint64_t startingToken, uint64_t size);
};

#endif
OpenPOWER on IntegriCloud