/* channel.h -- Definition of types and structures for
|
/* channel.h -- Definition of types and structures for
|
peripheral to communicate with host. Addapted from UML.
|
peripheral to communicate with host. Addapted from UML.
|
|
|
Copyright (C) 2002 Richard Prescott <rip@step.polymtl.ca>
|
Copyright (C) 2002 Richard Prescott <rip@step.polymtl.ca>
|
Copyright (C) 2008 Embecosm Limited
|
Copyright (C) 2008 Embecosm Limited
|
|
|
Contributor Jeremy Bennett <jeremy.bennett@embecosm.com>
|
Contributor Jeremy Bennett <jeremy.bennett@embecosm.com>
|
|
|
This file is part of Or1ksim, the OpenRISC 1000 Architectural Simulator.
|
This file is part of Or1ksim, the OpenRISC 1000 Architectural Simulator.
|
|
|
This program is free software; you can redistribute it and/or modify it
|
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
|
under the terms of the GNU General Public License as published by the Free
|
Software Foundation; either version 3 of the License, or (at your option)
|
Software Foundation; either version 3 of the License, or (at your option)
|
any later version.
|
any later version.
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
more details.
|
more details.
|
|
|
You should have received a copy of the GNU General Public License along
|
You should have received a copy of the GNU General Public License along
|
with this program. If not, see <http://www.gnu.org/licenses/>. */
|
with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
/* This program is commented throughout in a fashion suitable for processing
|
/* This program is commented throughout in a fashion suitable for processing
|
with Doxygen. */
|
with Doxygen. */
|
|
|
|
|
#ifndef CHANNEL__H
|
#ifndef CHANNEL__H
|
#define CHANNEL__H
|
#define CHANNEL__H
|
|
|
/*! A data structure representing all the functions required on a channel */
|
/*! A data structure representing all the functions required on a channel */
|
struct channel_ops
|
struct channel_ops
|
{
|
{
|
void *(*init) (const char *);
|
void *(*init) (const char *);
|
int (*open) (void *);
|
int (*open) (void *);
|
void (*close) (void *);
|
void (*close) (void *);
|
int (*read) (void *, char *, int);
|
int (*read) (void *, char *, int);
|
int (*write) (void *, const char *, int);
|
int (*write) (void *, const char *, int);
|
void (*free) (void *);
|
void (*free) (void *);
|
int (*isok) (void *);
|
int (*isok) (void *);
|
char *(*status) (void *);
|
char *(*status) (void *);
|
};
|
};
|
|
|
/*! A data structure representing a channel. Its operations and data */
|
/*! A data structure representing a channel. Its operations and data */
|
struct channel
|
struct channel
|
{
|
{
|
const struct channel_ops *ops;
|
const struct channel_ops *ops;
|
void *data;
|
void *data;
|
};
|
};
|
|
|
|
|
/* Function prototypes for external use */
|
/* Function prototypes for external use */
|
extern struct channel *channel_init (const char *descriptor);
|
extern struct channel *channel_init (const char *descriptor);
|
extern int channel_open (struct channel *channel);
|
extern int channel_open (struct channel *channel);
|
extern int channel_read (struct channel *channel,
|
extern int channel_read (struct channel *channel,
|
char *buffer,
|
char *buffer,
|
int size);
|
int size);
|
extern int channel_write (struct channel *channel,
|
extern int channel_write (struct channel *channel,
|
const char *buffer,
|
const char *buffer,
|
int size);
|
int size);
|
extern void channel_close (struct channel *channel);
|
extern void channel_close (struct channel *channel);
|
|
|
#endif /* CHANNEL__H */
|
#endif /* CHANNEL__H */
|
|
|
