/******************************************************************************

    AudioScience HPI driver
    Copyright (C) 1997-2011  AudioScience Inc. <support@audioscience.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of version 2 of the GNU General Public License as
    published by the Free Software Foundation;

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

HPI Operating System Specific macros for Linux Kernel driver

(C) Copyright AudioScience Inc. 1997-2003
******************************************************************************/
#ifndef _HPIOS_H_
#define _HPIOS_H_

#undef HPI_OS_LINUX_KERNEL
#define HPI_OS_LINUX_KERNEL

#define HPI_OS_DEFINED
#define HPI_BUILD_KERNEL_MODE

#include <linux/io.h>
#include <linux/ioctl.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/device.h>
#include <linux/firmware.h>
#include <linux/interrupt.h>
#include <linux/pci.h>
#include <linux/mutex.h>

#define HPI_NO_OS_FILE_OPS

/** Details of a memory area allocated with  pci_alloc_consistent
Need all info for parameters to pci_free_consistent
*/
struct consistent_dma_area {
        struct device *pdev;
        /* looks like dma-mapping dma_devres ?! */
        size_t size;
        void *vaddr;
        dma_addr_t dma_handle;
};

static inline u16 hpios_locked_mem_get_phys_addr(struct consistent_dma_area
        *locked_mem_handle, u32 *p_physical_addr)
{
        *p_physical_addr = locked_mem_handle->dma_handle;
        return 0;
}

static inline u16 hpios_locked_mem_get_virt_addr(struct consistent_dma_area
        *locked_mem_handle, void **pp_virtual_addr)
{
        *pp_virtual_addr = locked_mem_handle->vaddr;
        return 0;
}

static inline u16 hpios_locked_mem_valid(struct consistent_dma_area
        *locked_mem_handle)
{
        return locked_mem_handle->size != 0;
}

struct hpi_ioctl_linux {
        void __user *phm;
        void __user *phr;
};

/* Conflict?: H is already used by a number of drivers hid, bluetooth hci,
   and some sound drivers sb16, hdsp, emu10k. AFAIK 0xFC is ununsed command
*/
#define HPI_IOCTL_LINUX _IOWR('H', 0xFC, struct hpi_ioctl_linux)

#define HPI_DEBUG_FLAG_ERROR   KERN_ERR
#define HPI_DEBUG_FLAG_WARNING KERN_WARNING
#define HPI_DEBUG_FLAG_NOTICE  KERN_NOTICE
#define HPI_DEBUG_FLAG_INFO    KERN_INFO
#define HPI_DEBUG_FLAG_DEBUG   KERN_DEBUG
#define HPI_DEBUG_FLAG_VERBOSE KERN_DEBUG       /* kernel has no verbose */

#include <linux/spinlock.h>

#define HPI_LOCKING

struct hpios_spinlock {
        spinlock_t lock;        /* SEE hpios_spinlock */
        int lock_context;
};

/* The reason for all this evilness is that ALSA calls some of a drivers
 * operators in atomic context, and some not.  But all our functions channel
 * through the HPI_Message conduit, so we can't handle the different context
 * per function
 */
#define IN_LOCK_BH 1
#define IN_LOCK_IRQ 0
static inline void cond_lock(struct hpios_spinlock *l)
{
        if (irqs_disabled()) {
                /* NO bh or isr can execute on this processor,
                   so ordinary lock will do
                 */
                spin_lock(&((l)->lock));
                l->lock_context = IN_LOCK_IRQ;
        } else {
                spin_lock_bh(&((l)->lock));
                l->lock_context = IN_LOCK_BH;
        }
}

static inline void cond_unlock(struct hpios_spinlock *l)
{
        if (l->lock_context == IN_LOCK_BH)
                spin_unlock_bh(&((l)->lock));
        else
                spin_unlock(&((l)->lock));
}

#define hpios_msgxlock_init(obj)      spin_lock_init(&(obj)->lock)
#define hpios_msgxlock_lock(obj)   cond_lock(obj)
#define hpios_msgxlock_unlock(obj) cond_unlock(obj)

#define hpios_dsplock_init(obj)       spin_lock_init(&(obj)->dsp_lock.lock)
#define hpios_dsplock_lock(obj)    cond_lock(&(obj)->dsp_lock)
#define hpios_dsplock_unlock(obj)  cond_unlock(&(obj)->dsp_lock)

#ifdef CONFIG_SND_DEBUG
#define HPI_BUILD_DEBUG
#endif

#define HPI_ALIST_LOCKING
#define hpios_alistlock_init(obj)    spin_lock_init(&((obj)->list_lock.lock))
#define hpios_alistlock_lock(obj) spin_lock(&((obj)->list_lock.lock))
#define hpios_alistlock_unlock(obj) spin_unlock(&((obj)->list_lock.lock))

struct snd_card;

/** pci drvdata points to an instance of this struct */
struct hpi_adapter {
        struct hpi_adapter_obj *adapter;
        struct snd_card *snd_card;

        int irq;
        int interrupt_mode;
        void (*interrupt_callback) (struct hpi_adapter *);

        /* mutex prevents contention for one card
           between multiple user programs (via ioctl) */
        struct mutex mutex;
        char *p_buffer;
        size_t buffer_size;
};

#endif