/*
 * Header file for ach_ipc kernel driver
 *
 * Copyright (C) 2013, Prevas A/S
 * Copyright (C) 2015, Rice University
 *
 * Authors: Kim Boendergaard Poulsen <kibo@prevas.dk>
 *          Neil T. Dantam <ntd@rice.edu>
 *
 * This file is provided under the following "BSD-style" License:
 *
 *
 *   Redistribution and use in source and binary forms, with or
 *   without modification, are permitted provided that the following
 *   conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * 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.
 *
 *   * Neither the name of the copyright holder 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 HOLDER 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 ACH_KLINUX_H
#define ACH_KLINUX_H

/** \file ach_klinux.h
 *
 *  \brief This header file contains definitions for the kernel module
 *         structs corresponding to the userspace implementation in
 *         ach.h.
 *
 *  \author Kim Boendergaard Poulsen <kibo@prevas.dk>
 *
 */

#include "ach/generic.h"
#include "ach/klinux_generic.h"	/* ACH Kernel API, shared with userspace */

/* The struct controlling channel devices a.k.a. /dev/ach-<channelname> */
struct ach_ch_device {
	struct ach_ch_device *next;
	int minor;
	struct cdev cdev;
	struct device *device;
	struct ach_header *ach_data;	/* Has own lock to protect data */
};

static inline const char *
ach_ch_device_name ( struct ach_ch_device *ch_dev )
{
	return ch_dev->device->kobj.name;
}

/* The struct controlling the individual channel device file handles */
struct ach_ch_file {
	struct ach_header *shm;
	struct achk_opt mode;

	// Stuff from userspace ach.h: ach_channel_t
	uint64_t seq_num;         /**< last sequence number read */
	size_t next_index;        /**< next index entry to try get from */
	volatile unsigned int cancel; /**< flag to cancel channel gets */
};

typedef struct ach_ch_file ach_channel_t;

#endif

/* Local Variables:    */
/* mode: C             */
/* c-basic-offset: 8   */
/* indent-tabs-mode: t */
/* End:                */