hptrr(4): Add a __printflike().
[dragonfly.git] / sys / dev / raid / hptrr / osm.h
1 /*
2  * Copyright (c) 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: src/sys/dev/hptrr/osm.h,v 1.4 2008/03/08 18:06:48 scottl Exp $
27  */
28 #include <dev/raid/hptrr/hptrr_config.h>
29 /*
30  * $Id: osm.h,v 1.7 2007/12/10 02:13:52 xxj Exp $
31  * Copyright (C) 2005 HighPoint Technologies, Inc. All rights reserved.
32  */
33 #ifndef _HPT_OSM_H_
34 #define _HPT_OSM_H_
35
36 #define VERMAGIC_OSM 6
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 #define FAR
64 #define EXTERN_C
65
66 typedef void * HPT_PTR;
67
68 typedef HPT_U64 HPT_LBA;
69 typedef HPT_U64 HPT_RAW_LBA;
70 #define MAX_LBA_VALUE 0xffffffffffffffffull
71 #define MAX_RAW_LBA_VALUE MAX_LBA_VALUE
72 #define RAW_LBA(x) (x)
73 #define LO_LBA(x) ((HPT_U32)(x))
74 #define HI_LBA(x) (sizeof(HPT_LBA)>4? (HPT_U32)((x)>>32) : 0)
75 #define LBA_FORMAT_STR "0x%llX"
76
77 typedef HPT_U64 BUS_ADDRESS;
78 #define LO_BUSADDR(x) ((HPT_U32)(x))
79 #define HI_BUSADDR(x) (sizeof(BUS_ADDRESS)>4? (x)>>32 : 0)
80
81 typedef unsigned char HPT_BOOL;
82 #define HPT_TRUE  1
83 #define HPT_FALSE 0
84
85 typedef struct _TIME_RECORD {
86    HPT_U32        seconds:6;      /* 0 - 59 */
87    HPT_U32        minutes:6;      /* 0 - 59 */
88    HPT_U32        month:4;        /* 1 - 12 */
89    HPT_U32        hours:6;        /* 0 - 59 */
90    HPT_U32        day:5;          /* 1 - 31 */
91    HPT_U32        year:5;         /* 0=2000, 31=2031 */
92 } TIME_RECORD;
93
94 /* hardware access */
95 HPT_U8   os_inb  (void *port);
96 HPT_U16  os_inw  (void *port);
97 HPT_U32  os_inl  (void *port);
98 void     os_outb (void *port, HPT_U8 value);
99 void     os_outw (void *port, HPT_U16 value);
100 void     os_outl (void *port, HPT_U32 value);
101 void     os_insw (void *port, HPT_U16 *buffer, HPT_U32 count);
102 void     os_outsw(void *port, HPT_U16 *buffer, HPT_U32 count);
103
104 extern HPT_U32 __dummy_reg; /* to avoid the compiler warning */
105
106 #define os_readb(addr) (*(HPT_U8 *)&__dummy_reg = *(volatile HPT_U8 *)(addr))
107 #define os_readw(addr) (*(HPT_U16 *)&__dummy_reg = *(volatile HPT_U16 *)(addr))
108 #define os_readl(addr) (*(HPT_U32 *)&__dummy_reg = *(volatile HPT_U32 *)(addr))
109
110 #define os_writeb(addr, val) *(volatile HPT_U8 *)(addr) = (HPT_U8)(val)
111 #define os_writew(addr, val) *(volatile HPT_U16 *)(addr) = (HPT_U16)(val)
112 #define os_writel(addr, val) *(volatile HPT_U32 *)(addr) = (HPT_U32)(val)
113
114 /* PCI configuration space for specified device*/
115 HPT_U8   os_pci_readb (void *osext, HPT_U8 offset);
116 HPT_U16  os_pci_readw (void *osext, HPT_U8 offset);
117 HPT_U32  os_pci_readl (void *osext, HPT_U8 offset);
118 void     os_pci_writeb(void *osext, HPT_U8 offset, HPT_U8 value);
119 void     os_pci_writew(void *osext, HPT_U8 offset, HPT_U16 value);
120 void     os_pci_writel(void *osext, HPT_U8 offset, HPT_U32 value);
121
122 /* obsolute interface */
123 #define MAX_PCI_BUS_NUMBER 0xff
124 #define MAX_PCI_DEVICE_NUMBER 32
125 #define MAX_PCI_FUNC_NUMBER 8
126 #define pcicfg_read_dword(bus, dev, fn, reg) 0xffff
127
128
129 void *os_map_pci_bar(
130         void *osext,
131         int index,
132         HPT_U32 offset,
133         HPT_U32 length
134 );
135
136
137 void os_unmap_pci_bar(void *osext, void *base);
138
139 #define os_kmap_sgptr(psg) (psg->addr._logical)
140 #define os_kunmap_sgptr(ptr)
141 #define os_set_sgptr(psg, ptr) (psg)->addr._logical = (ptr)
142
143 /* timer */
144 void *os_add_timer(void *osext, HPT_U32 microseconds, void (*proc)(void *), void *arg);
145 void  os_del_timer(void *handle);
146 void  os_request_timer(void * osext, HPT_U32 interval);
147 HPT_TIME os_query_time(void);
148
149 /* task */
150 #define OS_SUPPORT_TASK
151
152 typedef struct _OSM_TASK {
153         struct _OSM_TASK *next;
154         void (*func)(void *vbus, void *data);
155         void *data;
156 }
157 OSM_TASK;
158
159 void os_schedule_task(void *osext, OSM_TASK *task);
160
161 /* misc */
162 HPT_U32 os_get_stamp(void);
163 void os_stallexec(HPT_U32 microseconds);
164
165 #ifndef _SYS_LIBKERN_H_
166 #define memcpy(dst, src, size) __builtin_memcpy((dst), (src), (size))
167 #define memcmp(dst, src, size) __builtin_memcmp((dst), (src), (size))
168 #define strcpy(dst, src) __builtin_strcpy((dst), (src))
169 static __inline void * memset(void *dst, int c, unsigned long size)
170 {
171         char *p;
172         for (p=(char*)dst; size; size--,p++) *p = c;
173         return dst;
174 }
175 #endif
176
177 #define farMemoryCopy(a,b,c) memcpy((char *)(a), (char *)(b), (HPT_U32)c)
178
179
180 #define os_register_device(osext, target_id)
181 #define os_unregister_device(osext, target_id)
182 int os_query_remove_device(void *osext, int target_id);
183 int os_revalidate_device(void *osext, int target_id);
184
185 HPT_U8 os_get_vbus_seq(void *osext);
186
187 /* debug support */
188 int  os_printk(char *fmt, ...) __printflike(1, 2);
189
190 #if DBG
191 extern int hptrr_dbg_level;
192 #define KdPrint(x)  do { if (hptrr_dbg_level) os_printk x; } while (0)
193 void __os_dbgbreak(const char *file, int line);
194 #define os_dbgbreak() __os_dbgbreak(__FILE__, __LINE__)
195 #define HPT_ASSERT(x) do { if (!(x)) os_dbgbreak(); } while (0)
196 void os_check_stack(const char *location, int size);
197 #define HPT_CHECK_STACK(size) os_check_stack(__FUNCTION__, (size))
198 #else
199 #define KdPrint(x)
200 #define HPT_ASSERT(x)
201 #define HPT_CHECK_STACK(size)
202 #endif
203
204 #define OsPrint(x) do { os_printk x; } while (0)
205
206 #endif