hx_stream.h

Go to the documentation of this file.

/****************************************************************************
 *
 *   Copyright (C) 2012 PX4 Development Team. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name PX4 nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

#ifndef _SYSTEMLIB_HX_STREAM_H
#define _SYSTEMLIB_HX_STREAM_H

#include <sys/types.h>

#include <perf/perf_counter.h>

struct hx_stream;
typedef struct hx_stream *hx_stream_t;

#define HX_STREAM_MAX_FRAME 64

typedef void (* hx_stream_rx_callback)(void *arg, const void *data, size_t length);

__BEGIN_DECLS

__EXPORT extern hx_stream_t hx_stream_init(int fd,
        hx_stream_rx_callback callback,
        void *arg);

__EXPORT extern void        hx_stream_free(hx_stream_t stream);

__EXPORT extern void        hx_stream_set_counters(hx_stream_t stream,
        perf_counter_t tx_frames,
        perf_counter_t rx_frames,
        perf_counter_t rx_errors);

__EXPORT extern void        hx_stream_reset(hx_stream_t stream);

__EXPORT extern int     hx_stream_start(hx_stream_t stream,
        const void *data,
        size_t count);

__EXPORT extern int     hx_stream_send_next(hx_stream_t stream);

__EXPORT extern int     hx_stream_send(hx_stream_t stream,
        const void *data,
        size_t count);

__EXPORT extern void        hx_stream_rx(hx_stream_t stream,
        uint8_t c);

__END_DECLS

#endif