looking-glass/client/ivshmem/ivshmem.h

/*
Looking Glass - KVM FrameRelay (KVMFR) Client
Copyright (C) 2017 Geoffrey McRae <geoff@hostfission.com>

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA
*/

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>

bool ivshmem_connect(const char * unix_socket);
void ivshmem_disconnect();
bool ivshmem_process();

uint16_t ivshmem_get_id();
void *   ivshmem_get_map();
size_t   ivshmem_get_map_size();

enum IVSHMEMWaitResult
{
  IVSHMEM_WAIT_RESULT_OK,
  IVSHMEM_WAIT_RESULT_TIMEOUT,
  IVSHMEM_WAIT_RESULT_ERROR
};

enum IVSHMEMWaitResult ivshmem_wait_irq(uint16_t vector, unsigned int timeout);
bool ivshmem_kick_irq(uint16_t clientID, uint16_t vector);