summaryrefslogtreecommitdiff
path: root/mobicore/MobiCoreDriverLib/ClientLib/Device.h
blob: d363babd8b7d310968d62346cf6b3befad205aed (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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*
 * Copyright (c) 2013 TRUSTONIC LIMITED
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the TRUSTONIC LIMITED nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/**
 * Client library device management.
 *
 * Device and Trustlet Session management Functions.
 */
#ifndef DEVICE_H_
#define DEVICE_H_

#include <stdint.h>
#include <vector>

#include "public/MobiCoreDriverApi.h"
#include "Session.h"
#include "CWsm.h"


class Device {


private:
    sessionList_t   sessionList; /**< MobiCore Trustlet session associated with the device */
    wsmList_t       wsmL2List; /**< WSM L2 Table  */
    bool            isValid_;



public:
    uint32_t     deviceId; /**< Device identifier */
    Connection   *connection; /**< The device connection */
    CMcKMod_ptr  pMcKMod;    

    Device(
        uint32_t    deviceId,
        Connection  *connection
    );

    virtual ~Device(
        void
    );

    /**
     * Open the device.
     * @param deviceName Name of the kernel modules device file.
     * @return true if the device has been opened successfully
     */
    bool open(
        const char *deviceName
    );

    /**
     * Closes the device.
     */
    void close(
        void
    );
    
    /**
     * Mark device as invalid.
     */
    void setInvalid()
    {
        isValid_ = false;
    }

    /**
     * Return whether device is valid.
     */
    bool isValid()
    {
        return isValid_;
    }



    /**
     * Check if the device has open sessions.
     * @return true if the device has one or more open sessions.
     */
    bool hasSessions(
        void
    );

    /**
     * Add a session to the device.
     * @param sessionId session ID
     * @param connection session connection
     * @return Session object created
     */
    Session *createNewSession(
        uint32_t    sessionId,
        Connection  *connection
    );

    /**
     * Remove the specified session from the device.
     * The session object will be destroyed and all resources associated with it will be freed.
     *
     * @param sessionId Session of the session to remove.
     * @return true if a session has been found and removed.
     */
    bool removeSession(
        uint32_t sessionId
    );

    /**
     * Get as session object for a given session ID.
     * @param sessionId Identified of a previously opened session.
     * @return Session object if available or NULL if no session has been found.
     */
    Session *resolveSessionId(
        uint32_t sessionId
    );

    /**
     * Allocate a block of contiguous WSM.
     * @param len The virtual address to be registered.
     * @param wsm The CWsm object of the allocated memory.
     * @return MC_DRV_OK if successful.
     */
    mcResult_t allocateContiguousWsm(
        uint32_t len,
        CWsm **wsm
    );

    /**
     * Unregister a vaddr from a device.
     * @param vaddr The virtual address to be registered.
     * @param paddr The physical address to be registered.
     */
    mcResult_t freeContiguousWsm(
        CWsm_ptr  pWsm
    );

    /**
     * Get a WSM object for a given virtual address.
     * @param vaddr The virtual address which has been allocate with mcMallocWsm() in advance.
     * @return the WSM object or NULL if no address has been found.
     */
    CWsm_ptr findContiguousWsm(
        addr_t  virtAddr
    );

    /**
     * Map a buffer from tlc VA to TL(Create L2 table for the buffer
     * @param buf The virtual address of hte buffer
     * @param len The length of the buffer
     * @param blkBuf The buffer object created
     * @return MC_DRV_OK if successful.
     */
    mcResult_t mapBulkBuf(
        addr_t buf,
        uint32_t len,
        BulkBufferDescriptor **blkBuf
    );

};

#endif /* DEVICE_H_ */