hal_iodevice.h

Go to the documentation of this file.

#ifndef HAL_IODEVICE_H
#define HAL_IODEVICE_H

#include <stdint.h>
#include <stddef.h>
#include <signal.h>
#include <stdarg.h>
#include "hal_config.h"
#include "hal_defs.h"
#if defined HAL_IO_OS_INTEGRATION && (HAL_IO_OS_INTEGRATION != 0)
#include "hal_os.h"
#endif



// -----------------------------------------------------------------------------
//  PUBLIC TYPEDEFS
// -----------------------------------------------------------------------------

#if defined HAL_IO_OS_INTEGRATION && (HAL_IO_OS_INTEGRATION != 0)

typedef OSTime IOTime;

#else

typedef unsigned int IOTime;

#endif // HAL_IO_OS_INTEGRATION


typedef struct IODeviceDesc* IODevice;


// -----------------------------------------------------------------------------
//  PUBLIC API
// -----------------------------------------------------------------------------

HALRESULT IODEV_Init(IODevice iodevice);

HALRESULT IODEV_Deinit(IODevice iodevice);

HALRESULT IODEV_IOCtl(IODevice iodevice, unsigned int request, ...);

HALRESULT IODEV_EnableWrite(IODevice iodevice);

HALRESULT IODEV_DisableWrite(IODevice iodevice);

HALRESULT IODEV_EnableRead(IODevice iodevice);

HALRESULT IODEV_DisableRead(IODevice iodevice);

size_t IODEV_GetReadCount(IODevice iodevice);

size_t IODEV_GetWriteSpace(IODevice iodevice);

size_t IODEV_Read(IODevice iodevice, void* data, size_t size, IOTime timeout);

size_t IODEV_Write(IODevice iodevice, const void* data, size_t size, IOTime timeout);

int IODEV_Lock(IODevice iodevice, unsigned int timeout);

void IODEV_Unlock(IODevice iodevice);

#endif // HAL_IODEVICE_H