sound/pci/asihpi/hpios.h

   1 /******************************************************************************
   2
   3     AudioScience HPI driver
   4     Copyright (C) 1997-2011  AudioScience Inc. <support@audioscience.com>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of version 2 of the GNU General Public License as
   8     published by the Free Software Foundation;
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18
  19 HPI Operating System Specific macros for Linux Kernel driver
  20
  21 (C) Copyright AudioScience Inc. 1997-2003
  22 ******************************************************************************/
  23 #ifndef _HPIOS_H_
  24 #define _HPIOS_H_
  25
  26 #undef HPI_OS_LINUX_KERNEL
  27 #define HPI_OS_LINUX_KERNEL
  28
  29 #define HPI_OS_DEFINED
  30 #define HPI_BUILD_KERNEL_MODE
  31
  32 #include <linux/io.h>
  33 #include <linux/ioctl.h>
  34 #include <linux/kernel.h>
  35 #include <linux/string.h>
  36 #include <linux/device.h>
  37 #include <linux/firmware.h>
  38 #include <linux/interrupt.h>
  39 #include <linux/pci.h>
  40 #include <linux/mutex.h>
  41
  42 #define HPI_NO_OS_FILE_OPS
  43
  44 #ifdef CONFIG_64BIT
  45 #define HPI64BIT
  46 #endif
  47
  48 /** Details of a memory area allocated with  pci_alloc_consistent
  49 Need all info for parameters to pci_free_consistent
  50 */
  51 struct consistent_dma_area {
  52         struct device *pdev;
  53         /* looks like dma-mapping dma_devres ?! */
  54         size_t size;
  55         void *vaddr;
  56         dma_addr_t dma_handle;
  57 };
  58
  59 static inline u16 hpios_locked_mem_get_phys_addr(struct consistent_dma_area
  60         *locked_mem_handle, u32 *p_physical_addr)
  61 {
  62         *p_physical_addr = locked_mem_handle->dma_handle;
  63         return 0;
  64 }
  65
  66 static inline u16 hpios_locked_mem_get_virt_addr(struct consistent_dma_area
  67         *locked_mem_handle, void **pp_virtual_addr)
  68 {
  69         *pp_virtual_addr = locked_mem_handle->vaddr;
  70         return 0;
  71 }
  72
  73 static inline u16 hpios_locked_mem_valid(struct consistent_dma_area
  74         *locked_mem_handle)
  75 {
  76         return locked_mem_handle->size != 0;
  77 }
  78
  79 struct hpi_ioctl_linux {
  80         void __user *phm;
  81         void __user *phr;
  82 };
  83
  84 /* Conflict?: H is already used by a number of drivers hid, bluetooth hci,
  85    and some sound drivers sb16, hdsp, emu10k. AFAIK 0xFC is ununsed command
  86 */
  87 #define HPI_IOCTL_LINUX _IOWR('H', 0xFC, struct hpi_ioctl_linux)
  88
  89 #define HPI_DEBUG_FLAG_ERROR   KERN_ERR
  90 #define HPI_DEBUG_FLAG_WARNING KERN_WARNING
  91 #define HPI_DEBUG_FLAG_NOTICE  KERN_NOTICE
  92 #define HPI_DEBUG_FLAG_INFO    KERN_INFO
  93 #define HPI_DEBUG_FLAG_DEBUG   KERN_DEBUG
  94 #define HPI_DEBUG_FLAG_VERBOSE KERN_DEBUG       /* kernel has no verbose */
  95
  96 #include <linux/spinlock.h>
  97
  98 #define HPI_LOCKING
  99
 100 struct hpios_spinlock {
 101         spinlock_t lock;        /* SEE hpios_spinlock */
 102         int lock_context;
 103 };
 104
 105 /* The reason for all this evilness is that ALSA calls some of a drivers
 106  * operators in atomic context, and some not.  But all our functions channel
 107  * through the HPI_Message conduit, so we can't handle the different context
 108  * per function
 109  */
 110 #define IN_LOCK_BH 1
 111 #define IN_LOCK_IRQ 0
 112 static inline void cond_lock(struct hpios_spinlock *l)
 113 {
 114         if (irqs_disabled()) {
 115                 /* NO bh or isr can execute on this processor,
 116                    so ordinary lock will do
 117                  */
 118                 spin_lock(&((l)->lock));
 119                 l->lock_context = IN_LOCK_IRQ;
 120         } else {
 121                 spin_lock_bh(&((l)->lock));
 122                 l->lock_context = IN_LOCK_BH;
 123         }
 124 }
 125
 126 static inline void cond_unlock(struct hpios_spinlock *l)
 127 {
 128         if (l->lock_context == IN_LOCK_BH)
 129                 spin_unlock_bh(&((l)->lock));
 130         else
 131                 spin_unlock(&((l)->lock));
 132 }
 133
 134 #define hpios_msgxlock_init(obj)      spin_lock_init(&(obj)->lock)
 135 #define hpios_msgxlock_lock(obj)   cond_lock(obj)
 136 #define hpios_msgxlock_unlock(obj) cond_unlock(obj)
 137
 138 #define hpios_dsplock_init(obj)       spin_lock_init(&(obj)->dsp_lock.lock)
 139 #define hpios_dsplock_lock(obj)    cond_lock(&(obj)->dsp_lock)
 140 #define hpios_dsplock_unlock(obj)  cond_unlock(&(obj)->dsp_lock)
 141
 142 #ifdef CONFIG_SND_DEBUG
 143 #define HPI_BUILD_DEBUG
 144 #endif
 145
 146 #define HPI_ALIST_LOCKING
 147 #define hpios_alistlock_init(obj)    spin_lock_init(&((obj)->list_lock.lock))
 148 #define hpios_alistlock_lock(obj) spin_lock(&((obj)->list_lock.lock))
 149 #define hpios_alistlock_unlock(obj) spin_unlock(&((obj)->list_lock.lock))
 150
 151 struct snd_card;
 152
 153 /** pci drvdata points to an instance of this struct */
 154 struct hpi_adapter {
 155         struct hpi_adapter_obj *adapter;
 156         struct snd_card *snd_card;
 157
 158         /* mutex prevents contention for one card
 159            between multiple user programs (via ioctl) */
 160         struct mutex mutex;
 161         char *p_buffer;
 162         size_t buffer_size;
 163 };
 164
 165 #endif