sys/dev/hpt27xx/osm.h

   1 /*-
   2  * Copyright (c) 2011 HighPoint Technologies, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #include <dev/hpt27xx/hpt27xx_config.h>
  30
  31 #ifndef _HPT_OSM_H_
  32 #define _HPT_OSM_H_
  33
  34 #define VERMAGIC_OSM 6
  35
  36
  37 #define MAX_MEMBERS 64
  38
  39 #define os_max_queue_comm 32
  40 #define os_max_sg_descriptors 18
  41
  42
  43 extern int os_max_cache_size;
  44
  45
  46 #define DMAPOOL_PAGE_SIZE 0x1000 /* PAGE_SIZE (i386/x86_64) */
  47 #define os_max_cache_pages (os_max_cache_size/DMAPOOL_PAGE_SIZE)
  48
  49 /* data types */
  50 typedef unsigned int HPT_UINT, HPT_U32;
  51 typedef unsigned long HPT_UPTR;
  52 typedef unsigned short HPT_U16;
  53 typedef unsigned char HPT_U8;
  54 typedef unsigned long HPT_TIME;
  55 typedef unsigned long long HPT_U64;
  56
  57 #define CPU_TO_LE64(x) (x)
  58 #define CPU_TO_LE32(x) (x)
  59 #define CPU_TO_LE16(x) (x)
  60 #define LE32_TO_CPU(x) (x)
  61 #define LE16_TO_CPU(x) (x)
  62 #define LE64_TO_CPU(x) (x)
  63
  64 static __inline HPT_U64 CPU_TO_BE64(HPT_U64 x)
  65 {
  66         HPT_U8 *p = (HPT_U8 *)&x;
  67         return ((HPT_U64)p[0] << 56) |
  68                 ((HPT_U64)p[1] << 48) |
  69                 ((HPT_U64)p[2] << 40) |
  70                 ((HPT_U64)p[3] << 32) |
  71                 ((HPT_U64)p[4] << 24) |
  72                 ((HPT_U64)p[5] << 16) |
  73                 ((HPT_U64)p[6] << 8) |
  74                 p[7];
  75 }
  76
  77 static __inline HPT_U32 CPU_TO_BE32(HPT_U32 x)
  78 {
  79         HPT_U8 *p = (HPT_U8 *)&x;
  80         return ((HPT_U32)p[0] << 24) |
  81                 ((HPT_U32)p[1] << 16) |
  82                 ((HPT_U32)p[2] << 8) | p[3];
  83 }
  84
  85 static __inline HPT_U16 CPU_TO_BE16(HPT_U16 x)
  86 {
  87         return ((HPT_U8)x << 8) | (x>>8);
  88 }
  89
  90 #define BE16_TO_CPU(x) CPU_TO_BE16(x)
  91 #define BE32_TO_CPU(x) CPU_TO_BE32(x)
  92 #define BE64_TO_CPU(x) CPU_TO_BE64(x)
  93
  94 #define FAR
  95 #define EXTERN_C
  96
  97 typedef void * HPT_PTR;
  98
  99 typedef HPT_U64 HPT_LBA;
 100 typedef HPT_U64 HPT_RAW_LBA;
 101 #define MAX_LBA_VALUE 0xffffffffffffffffull
 102 #define MAX_RAW_LBA_VALUE MAX_LBA_VALUE
 103 #define RAW_LBA(x) (x)
 104 #define LO_LBA(x) ((HPT_U32)(x))
 105 #define HI_LBA(x) (sizeof(HPT_LBA)>4? (HPT_U32)((x)>>32) : 0)
 106 #define LBA_FORMAT_STR "0x%llX"
 107
 108 typedef HPT_U64 BUS_ADDRESS;
 109 #define LO_BUSADDR(x) ((HPT_U32)(x))
 110 #define HI_BUSADDR(x) (sizeof(BUS_ADDRESS)>4? (x)>>32 : 0)
 111
 112 typedef unsigned char HPT_BOOL;
 113 #define HPT_TRUE  1
 114 #define HPT_FALSE 0
 115
 116 typedef struct _TIME_RECORD {
 117    HPT_U32        seconds:6;      /* 0 - 59 */
 118    HPT_U32        minutes:6;      /* 0 - 59 */
 119    HPT_U32        month:4;        /* 1 - 12 */
 120    HPT_U32        hours:6;        /* 0 - 59 */
 121    HPT_U32        day:5;          /* 1 - 31 */
 122    HPT_U32        year:5;         /* 0=2000, 31=2031 */
 123 } TIME_RECORD;
 124
 125 /* hardware access */
 126 HPT_U8   os_inb  (void *port);
 127 HPT_U16  os_inw  (void *port);
 128 HPT_U32  os_inl  (void *port);
 129 void     os_outb (void *port, HPT_U8 value);
 130 void     os_outw (void *port, HPT_U16 value);
 131 void     os_outl (void *port, HPT_U32 value);
 132 void     os_insw (void *port, HPT_U16 *buffer, HPT_U32 count);
 133 void     os_outsw(void *port, HPT_U16 *buffer, HPT_U32 count);
 134
 135 extern HPT_U32 __dummy_reg; /* to avoid the compiler warning */
 136
 137 #define os_readb(addr) (*(HPT_U8 *)&__dummy_reg = *(volatile HPT_U8 *)(addr))
 138 #define os_readw(addr) (*(HPT_U16 *)&__dummy_reg = *(volatile HPT_U16 *)(addr))
 139 #define os_readl(addr) (*(HPT_U32 *)&__dummy_reg = *(volatile HPT_U32 *)(addr))
 140
 141 #define os_writeb(addr, val) *(volatile HPT_U8 *)(addr) = (HPT_U8)(val)
 142 #define os_writew(addr, val) *(volatile HPT_U16 *)(addr) = (HPT_U16)(val)
 143 #define os_writel(addr, val) *(volatile HPT_U32 *)(addr) = (HPT_U32)(val)
 144
 145 /* PCI configuration space for specified device*/
 146 HPT_U8   os_pci_readb (void *osext, HPT_U8 offset);
 147 HPT_U16  os_pci_readw (void *osext, HPT_U8 offset);
 148 HPT_U32  os_pci_readl (void *osext, HPT_U8 offset);
 149 void     os_pci_writeb(void *osext, HPT_U8 offset, HPT_U8 value);
 150 void     os_pci_writew(void *osext, HPT_U8 offset, HPT_U16 value);
 151 void     os_pci_writel(void *osext, HPT_U8 offset, HPT_U32 value);
 152
 153 /* obsolute interface */
 154 #define MAX_PCI_BUS_NUMBER 0xff
 155 #define MAX_PCI_DEVICE_NUMBER 32
 156 #define MAX_PCI_FUNC_NUMBER 1
 157 HPT_U8 pcicfg_read_byte (HPT_U8 bus, HPT_U8 dev, HPT_U8 func, HPT_U8 reg);
 158 HPT_U32 pcicfg_read_dword(HPT_U8 bus, HPT_U8 dev, HPT_U8 func, HPT_U8 reg);
 159 void pcicfg_write_byte (HPT_U8 bus, HPT_U8 dev, HPT_U8 func, HPT_U8 reg, HPT_U8 v);
 160 void pcicfg_write_dword(HPT_U8 bus, HPT_U8 dev, HPT_U8 func, HPT_U8 reg, HPT_U32 v);
 161
 162
 163 void *os_map_pci_bar(
 164         void *osext,
 165         int index,
 166         HPT_U32 offset,
 167         HPT_U32 length
 168 );
 169
 170
 171 void os_unmap_pci_bar(void *osext, void *base);
 172
 173 #define os_kmap_sgptr(psg) (psg->addr._logical)
 174 #define os_kunmap_sgptr(ptr)
 175 #define os_set_sgptr(psg, ptr) (psg)->addr._logical = (ptr)
 176
 177 /* timer */
 178 void *os_add_timer(void *osext, HPT_U32 microseconds, void (*proc)(void *), void *arg);
 179 void  os_del_timer(void *handle);
 180 void  os_request_timer(void * osext, HPT_U32 interval);
 181 HPT_TIME os_query_time(void);
 182
 183 /* task */
 184 #define OS_SUPPORT_TASK
 185
 186 typedef struct _OSM_TASK {
 187         struct _OSM_TASK *next;
 188         void (*func)(void *vbus, void *data);
 189         void *data;
 190 }
 191 OSM_TASK;
 192
 193 void os_schedule_task(void *osext, OSM_TASK *task);
 194
 195 /* misc */
 196 HPT_U32 os_get_stamp(void);
 197 void os_stallexec(HPT_U32 microseconds);
 198
 199 #ifndef _SYS_LIBKERN_H_
 200 #define memcpy(dst, src, size) __builtin_memcpy((dst), (src), (size))
 201 #define memcmp(dst, src, size) __builtin_memcmp((dst), (src), (size))
 202 #define strcpy(dst, src) __builtin_strcpy((dst), (src))
 203 static __inline void * memset(void *dst, int c, unsigned long size)
 204 {
 205         char *p;
 206         for (p=(char*)dst; size; size--,p++) *p = c;
 207         return dst;
 208 }
 209 #endif
 210
 211 #define farMemoryCopy(a,b,c) memcpy((char *)(a), (char *)(b), (HPT_U32)c)
 212
 213
 214 #define os_register_device(osext, target_id)
 215 #define os_unregister_device(osext, target_id)
 216 int os_query_remove_device(void *osext, int target_id);
 217 int os_revalidate_device(void *osext, int target_id);
 218
 219 HPT_U8 os_get_vbus_seq(void *osext);
 220
 221 /* debug support */
 222 int  os_printk(char *fmt, ...);
 223
 224 #if DBG
 225 extern int hpt_dbg_level;
 226 #define KdPrint(x)  do { if (hpt_dbg_level) os_printk x; } while (0)
 227 void __os_dbgbreak(const char *file, int line);
 228 #define os_dbgbreak() __os_dbgbreak(__FILE__, __LINE__)
 229 #define HPT_ASSERT(x) do { if (!(x)) os_dbgbreak(); } while (0)
 230 void os_check_stack(const char *location, int size);
 231 #define HPT_CHECK_STACK(size) os_check_stack(__FUNCTION__, (size))
 232 #else
 233 #define KdPrint(x)
 234 #define HPT_ASSERT(x)
 235 #define HPT_CHECK_STACK(size)
 236 #endif
 237
 238 #define OsPrint(x) do { os_printk x; } while (0)
 239
 240 #endif