2007-04-27 00:44:52 +02:00
|
|
|
#ifndef _GPXE_XFER_H
|
|
|
|
#define _GPXE_XFER_H
|
|
|
|
|
|
|
|
/** @file
|
|
|
|
*
|
|
|
|
* Data transfer interfaces
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <stddef.h>
|
2007-04-28 22:56:24 +02:00
|
|
|
#include <stdarg.h>
|
2007-04-27 00:44:52 +02:00
|
|
|
#include <gpxe/interface.h>
|
|
|
|
#include <gpxe/iobuf.h>
|
|
|
|
|
|
|
|
struct xfer_interface;
|
|
|
|
|
|
|
|
/** Data transfer interface operations */
|
|
|
|
struct xfer_interface_operations {
|
2007-04-28 22:56:24 +02:00
|
|
|
|
|
|
|
/* Missing features:
|
|
|
|
*
|
|
|
|
* notification of non-close status - e.g. connected/opened, ...
|
|
|
|
*
|
|
|
|
* seek
|
|
|
|
*
|
|
|
|
* prompt for data delivery
|
|
|
|
*
|
|
|
|
* I/O buffer preparation
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
/** Close interface
|
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-28 22:56:24 +02:00
|
|
|
* @v rc Reason for close
|
|
|
|
*/
|
|
|
|
void ( * close ) ( struct xfer_interface *xfer, int rc );
|
|
|
|
/** Redirect to new location
|
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-28 22:56:24 +02:00
|
|
|
* @v type New location type
|
|
|
|
* @v args Remaining arguments depend upon location type
|
|
|
|
* @ret rc Return status code
|
|
|
|
*/
|
|
|
|
int ( * vredirect ) ( struct xfer_interface *xfer, int type,
|
|
|
|
va_list args );
|
2007-04-29 04:03:58 +02:00
|
|
|
/** Seek to position
|
|
|
|
*
|
|
|
|
* @v xfer Data transfer interface
|
|
|
|
* @v pos New position
|
|
|
|
* @ret rc Return status code
|
|
|
|
*/
|
|
|
|
int ( * seek ) ( struct xfer_interface *xfer, size_t pos );
|
2007-04-27 00:44:52 +02:00
|
|
|
/** Deliver datagram
|
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
* @v iobuf Datagram I/O buffer
|
|
|
|
* @ret rc Return status code
|
2007-04-27 02:02:23 +02:00
|
|
|
*
|
|
|
|
* A data transfer interface that wishes to support only raw
|
|
|
|
* data delivery should set this method to
|
|
|
|
* deliver_as_raw().
|
2007-04-27 00:44:52 +02:00
|
|
|
*/
|
|
|
|
int ( * deliver ) ( struct xfer_interface *xfer,
|
|
|
|
struct io_buffer *iobuf );
|
2007-04-27 02:02:23 +02:00
|
|
|
/** Deliver datagram as raw data
|
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 02:02:23 +02:00
|
|
|
* @v data Data buffer
|
|
|
|
* @v len Length of data buffer
|
|
|
|
* @ret rc Return status code
|
|
|
|
*
|
|
|
|
* A data transfer interface that wishes to support only I/O
|
|
|
|
* buffer delivery should set this method to
|
|
|
|
* deliver_as_iobuf().
|
|
|
|
*/
|
|
|
|
int ( * deliver_raw ) ( struct xfer_interface *xfer,
|
|
|
|
const void *data, size_t len );
|
2007-04-27 00:44:52 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
/** A data transfer interface */
|
|
|
|
struct xfer_interface {
|
|
|
|
/** Generic object communication interface */
|
|
|
|
struct interface intf;
|
|
|
|
/** Operations for received messages */
|
|
|
|
struct xfer_interface_operations *op;
|
|
|
|
};
|
|
|
|
|
|
|
|
extern struct xfer_interface null_xfer;
|
|
|
|
extern struct xfer_interface_operations null_xfer_ops;
|
|
|
|
|
2007-04-29 04:03:58 +02:00
|
|
|
extern void close ( struct xfer_interface *xfer, int rc );
|
|
|
|
extern int seek ( struct xfer_interface *xfer, size_t pos );
|
2007-04-28 22:56:24 +02:00
|
|
|
extern int vredirect ( struct xfer_interface *xfer, int type, va_list args );
|
|
|
|
extern int redirect ( struct xfer_interface *xfer, int type, ... );
|
|
|
|
extern int deliver ( struct xfer_interface *xfer, struct io_buffer *iobuf );
|
|
|
|
extern int deliver_raw ( struct xfer_interface *xfer,
|
|
|
|
const void *data, size_t len );
|
|
|
|
|
2007-04-29 04:03:58 +02:00
|
|
|
extern void ignore_close ( struct xfer_interface *xfer, int rc );
|
|
|
|
extern int ignore_vredirect ( struct xfer_interface *xfer,
|
|
|
|
int type, va_list args );
|
|
|
|
extern int ignore_seek ( struct xfer_interface *xfer, size_t pos );
|
2007-04-27 02:02:23 +02:00
|
|
|
extern int deliver_as_raw ( struct xfer_interface *xfer,
|
|
|
|
struct io_buffer *iobuf );
|
|
|
|
extern int deliver_as_iobuf ( struct xfer_interface *xfer,
|
|
|
|
const void *data, size_t len );
|
2007-04-29 04:03:58 +02:00
|
|
|
extern int ignore_deliver_raw ( struct xfer_interface *xfer,
|
|
|
|
const void *data __unused, size_t len );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Initialise a data transfer interface
|
|
|
|
*
|
|
|
|
* @v xfer Data transfer interface
|
|
|
|
* @v op Data transfer interface operations
|
|
|
|
* @v refcnt Data transfer interface reference counting method
|
|
|
|
*/
|
|
|
|
static inline void xfer_init ( struct xfer_interface *xfer,
|
|
|
|
struct xfer_interface_operations *op,
|
|
|
|
void ( * refcnt ) ( struct interface *intf,
|
|
|
|
int delta ) ) {
|
|
|
|
xfer->intf.dest = &null_xfer.intf;
|
|
|
|
xfer->intf.refcnt = refcnt;
|
|
|
|
xfer->op = op;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get data transfer interface from generic object communication interface
|
|
|
|
*
|
|
|
|
* @v intf Generic object communication interface
|
|
|
|
* @ret xfer Data transfer interface
|
|
|
|
*/
|
|
|
|
static inline struct xfer_interface *
|
|
|
|
intf_to_xfer ( struct interface *intf ) {
|
|
|
|
return container_of ( intf, struct xfer_interface, intf );
|
|
|
|
}
|
2007-04-27 02:02:23 +02:00
|
|
|
|
|
|
|
/**
|
2007-04-29 04:03:58 +02:00
|
|
|
* Get destination data transfer interface
|
2007-04-27 02:02:23 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 02:02:23 +02:00
|
|
|
* @ret dest Destination interface
|
|
|
|
*/
|
2007-04-27 00:44:52 +02:00
|
|
|
static inline struct xfer_interface *
|
|
|
|
xfer_dest ( struct xfer_interface *xfer ) {
|
2007-04-29 04:03:58 +02:00
|
|
|
return intf_to_xfer ( xfer->intf.dest );
|
2007-04-27 00:44:52 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2007-04-29 04:03:58 +02:00
|
|
|
* Plug a data transfer interface into a new destination interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
* @v dest New destination interface
|
|
|
|
*/
|
|
|
|
static inline void xfer_plug ( struct xfer_interface *xfer,
|
|
|
|
struct xfer_interface *dest ) {
|
|
|
|
plug ( &xfer->intf, &dest->intf );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2007-04-29 04:03:58 +02:00
|
|
|
* Unplug a data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*/
|
|
|
|
static inline void xfer_unplug ( struct xfer_interface *xfer ) {
|
|
|
|
plug ( &xfer->intf, &null_xfer.intf );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2007-04-29 04:03:58 +02:00
|
|
|
* Stop using a data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
2007-04-29 04:03:58 +02:00
|
|
|
* @v xfer Data transfer interface
|
2007-04-27 00:44:52 +02:00
|
|
|
*
|
|
|
|
* After calling this method, no further messages will be received via
|
|
|
|
* the interface.
|
|
|
|
*/
|
2007-04-29 04:03:58 +02:00
|
|
|
static inline void xfer_nullify ( struct xfer_interface *xfer ) {
|
2007-04-27 00:44:52 +02:00
|
|
|
xfer->op = &null_xfer_ops;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* _GPXE_XFER_H */
|