mobicore/ClientLib/src/iclient.h

   1 /*
   2  * Copyright (c) 2013-2015 TRUSTONIC LIMITED
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * 3. Neither the name of the TRUSTONIC LIMITED nor the names of its
  16  *    contributors may be used to endorse or promote products derived from
  17  *    this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef __CLIENT_INTERFACE_H__
  33 #define __CLIENT_INTERFACE_H__
  34
  35 #include <stdint.h>     // *int*_t
  36 #include <sys/types.h>  // uid_t git_t
  37 #include "mc_user.h"    // ioctl structures
  38
  39 class IClient {
  40 public:
  41     virtual ~IClient() {}
  42     virtual int open() = 0;
  43     virtual int close() = 0;
  44     virtual bool isOpen() const = 0;
  45     // MC protocol, also used by GP for now
  46     virtual int hasOpenSessions() const = 0;
  47     virtual int openSession(struct mc_ioctl_open_session& session) = 0;
  48     virtual int openTrustlet(struct mc_ioctl_open_trustlet& trustlet) = 0;
  49     virtual int closeSession(uint32_t session_id) = 0;
  50     virtual int notify(uint32_t session_id) = 0;
  51     virtual int waitNotification(const struct mc_ioctl_wait& wait) = 0;
  52     virtual int malloc(uint8_t** buffer, uint32_t length) = 0;
  53     virtual int free(uint8_t* buffer, uint32_t length) = 0;
  54     virtual int map(struct mc_ioctl_map& map) = 0;
  55     virtual int unmap(const struct mc_ioctl_map& map) = 0;
  56     virtual int getError(struct mc_ioctl_geterr& err) = 0;
  57     virtual int getVersion(struct mc_version_info& version_info) = 0;
  58     // GP protocol only
  59     virtual int gpRequestCancellation(uint32_t session_id) = 0;
  60 };
  61
  62 #endif // __CLIENT_INTERFACE_H__