sys/dev/hptnr/osm.h

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