1 /* $Id: ldm.h,v 1.78 2010/05/10 10:08:46 lcn Exp $ */
3 * Copyright (C) 2005-2011 HighPoint Technologies, Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
29 #include <dev/hptnr/hptnr_config.h>
33 #define VERMAGIC_LDM 75
35 #if defined(__cplusplus)
40 #define __hpt_set_ver(x, v1, v2, v3, v4, v5) x ## _R_ ## v1 ## _ ## v2 ## _ ## v3 ## _ ## v4 ## _ ## v5
41 #define _hpt_set_ver(x, v1, v2, v3, v4, v5) __hpt_set_ver(x, v1, v2, v3, v4, v5)
42 #define hpt_set_ver(x) _hpt_set_ver(x, VERMAGIC_OSM, VERMAGIC_HIM, VERMAGIC_LDM, VERMAGIC_ARRAY, MAX_MEMBERS)
44 #define ldm_register_him hpt_set_ver(ldm_register_him)
45 #define ldm_register_vdev_class hpt_set_ver(ldm_register_vdev_class)
46 #define ldm_alloc_cmds hpt_set_ver(ldm_alloc_cmds)
49 #ifndef HPT_INTERFACE_VERSION
50 #define HPT_INTERFACE_VERSION 0x02010000
53 #ifndef MAX_PARTITIONS_PER_DISK
54 #define MAX_PARTITIONS_PER_DISK 4
57 #if defined(__MAX_PARTITIONS_PER_DISK) && MAX_PARTITIONS_PER_DISK > __MAX_PARTITIONS_PER_DISK
58 #error "Please redefine MAX_PARTITIONS_PER_DISK!!!"
61 #define MAX(a,b) (((a)>(b))?(a):(b))
62 #define MIN(a,b) (((a)<(b))?(a):(b))
65 typedef char check_HPT_TIME_is_unsigned[ (HPT_TIME)(-1) > 0 ? 1 : -1 ];
67 #define hpt_time_after_eq(a, b) ((int)(a) - (int)(b) >= 0)
68 #define hpt_time_after(a, b) ((int)(a) - (int)(b) > 0)
78 struct freelist *next;
81 HPT_UINT reserved_count;
82 #define freelist_debug_tag(list, _tag) (list)->tag = _tag
84 #define freelist_debug_tag(list, _tag)
89 void freelist_reserve(struct freelist *list, void *osext, HPT_UINT size, HPT_UINT count);
91 void *freelist_get(struct freelist *);
92 void freelist_put(struct freelist *, void *p);
94 void freelist_reserve_dma(struct freelist *list, void *osext, HPT_UINT size, HPT_UINT alignment, HPT_UINT count);
95 void *freelist_get_dma(struct freelist *, BUS_ADDRESS *busaddr);
96 void freelist_put_dma(struct freelist *, void *p, BUS_ADDRESS busaddr);
99 #define freelist_reserve_with_tag(list, osext, size, count) \
101 freelist_debug_tag(list, #list " at " __FILE__);\
102 freelist_reserve(list, osext, (HPT_UINT)(size), (HPT_UINT)(count));\
105 #define freelist_reserve_dma_with_tag(list, osext, size, alignment, count) \
107 freelist_debug_tag(list, #list " at " __FILE__);\
108 freelist_reserve_dma(list, osext, (HPT_UINT)(size), (HPT_UINT)(alignment), (HPT_UINT)(count));\
111 struct lock_request {
113 struct lock_request *next;
114 struct list_head waiters; /* blocked commands */
115 struct tq_item callback;
119 #define INIT_LOCK_REQUEST(req, _start, _end, _cb, _arg, _cc) \
122 (req)->start = _start;\
124 INIT_TQ_ITEM(&(req)->callback, _cb, _arg);\
125 INIT_LIST_HEAD(&(req)->waiters);\
126 (req)->lock_cc = _cc;\
130 struct tq_item *head, *tail;
133 #define TQ_EMPTY(tq) ((tq)->head==0)
135 struct dmapool_order {
137 struct tq_item wakeup_fn;
138 struct dmapool_order *next;
141 struct dmapool_client {
143 HPT_UINT (*shrink)(void *handle, HPT_UINT npages);
144 int (*resume)(void *handle);
145 struct dmapool_client *next;
148 typedef struct _VBUS * PVBUS;
149 typedef struct _VDEV * PVDEV;
152 void dmapool_register_client(PVBUS vbus, struct dmapool_client *client);
155 void dmapool_active(PVBUS vbus);
157 /* return 0 if the request is immediately satisfied, non-zero otherwise. */
158 int dmapool_make_order(PVBUS vbus, struct dmapool_order *order);
161 void *dmapool_get_page(PVBUS vbus, BUS_ADDRESS *busaddr);
162 void *dmapool_get_page_at(PVBUS vbus, void *p, BUS_ADDRESS *busaddr);
163 void dmapool_put_page(PVBUS vbus, void *p, BUS_ADDRESS busaddr);
164 void dmapool_init(PVBUS vbus);
165 HPT_UINT dmapool_max_class_pages(PVBUS vbus);
169 HPT_U32 interval; /*microseconds*/
170 HPT_TIME expire_time; /*microseconds*/
171 void (*proc)(void * arg);
173 struct timer_call ** pprev;
174 struct timer_call * next;
177 #define ldm_init_timer(timer) do { (timer)->next=0; (timer)->pprev=0; } while (0)
179 #define INIT_TIMER_CALL(timer, _interval, _proc, _arg) \
181 HPT_ASSERT((timer)->next==0 && (timer)->pprev==0);\
182 (timer)->interval = _interval;\
183 (timer)->proc = _proc;\
184 (timer)->arg = _arg;\
187 void ldm_request_timer(PVBUS vbus, struct timer_call * tc);
188 void ldm_remove_timer(PVBUS vbus, struct timer_call * tc);
189 void ldm_on_timer(PVBUS vbus);
192 typedef struct _LDM_ADAPTER
194 struct _LDM_ADAPTER *next;
198 struct freelist freelist_dev;
200 struct freelist freelist_plugged_dpc;
203 LDM_ADAPTER, *PLDM_ADAPTER;
205 typedef struct _IOCTL_ARG
207 struct list_head link;
209 HPT_U32 dwIoControlCode;
210 HPT_U32 nInBufferSize;
211 HPT_U32 nOutBufferSize;
214 HPT_U32 *lpBytesReturned;
216 void (* done)(struct _IOCTL_ARG *);
217 int result; /* HPT_IOCTL_RESULT_ */
221 #define HPT_IOCTL_RESULT_OK 0
222 #define HPT_IOCTL_RESULT_FAILED (-1)
223 #define HPT_IOCTL_RESULT_INVALID (-2)
224 #define HPT_IOCTL_RESULT_RETRY (-3)
225 #define HPT_IOCTL_RESULT_WRONG_VBUS (-4)
227 void ldm_ioctl( PVBUS vbus, IOCTL_ARG *IAPnt);
228 void ldm_set_autorebuild(PVBUS vbus, int enable);
229 HPT_U32 ldm_get_device_id(PVDEV vd); /* for ioctl */
231 #ifndef __HPT_RAW_LBA
232 #define __HPT_RAW_LBA HPT_RAW_LBA
235 #include <dev/hptnr/array.h>
237 typedef struct hpt_raw_disk
240 PRAW_PARTITION raw_part_list;
241 __HPT_RAW_LBA max_available_capacity;
242 __HPT_RAW_LBA total_available_capacity;
244 __HPT_RAW_LBA real_capacity;
245 __HPT_RAW_LBA head_position;
247 HPT_U16 max_sectors_per_cmd;
248 HPT_U8 max_queue_depth;
249 HPT_U8 user_select_mode;
251 HPT_UINT uninitialized : 1;
252 HPT_UINT legacy_disk : 1;
253 HPT_UINT is_spare : 1;
254 HPT_UINT v3_format : 1;
255 HPT_UINT need_sync : 1;
256 HPT_UINT temp_spare : 1;
257 HPT_UINT need_check_array : 1;
258 HPT_UINT df_user_mode_set: 1;
260 HPT_UINT df_read_ahead_set: 1;
261 HPT_UINT enable_read_ahead : 1;
262 HPT_UINT df_write_cache_set: 1;
263 HPT_UINT enable_write_cache : 1;
264 HPT_UINT df_tcq_set: 1;
265 HPT_UINT enable_tcq : 1;
266 HPT_UINT df_ncq_set: 1;
267 HPT_UINT enable_ncq : 1;
269 HPT_UINT bad_sector : 1;
274 PLDM_ADAPTER adapter;
279 struct tq_item reset_dpc;
282 struct tq_item fail_dpc;
285 HPT_RAW_DISK, *PHPT_RAW_DISK;
289 struct vdev_class *next;
292 HPT_U8 stripped; /* RAID0,3,5,6 */
293 HPT_U8 redundancy; /* RAID1-1, RAID3/5-1, RAID6-2 */
294 HPT_U8 must_init; /* RAID3,5,6 */
297 HPT_UINT vbus_ext_size;
298 HPT_UINT vbus_ext_offset; /* used by LDM */
299 HPT_UINT dev_ext_size;
300 HPT_UINT cmd_ext_size;
303 void (*get_mem_info)(PVBUS vbus, void *osext, int phydev_count);
304 void (*queue_cmd)(PCOMMAND cmd);
305 void (*member_failed)(struct _VDEV * vd);
308 void (*initialize)(PVBUS vbus);
309 void (*release)(PVBUS vbus);
310 int (*add)(PVDEV vd);
311 void (*remove)(PVDEV vd);
312 void (*reset)(PVDEV vd);
313 void (*sync_stamp)(PVDEV vd);
314 int (*support_type)(int type);
318 #define VDEV_CLASS_CONSTRUCTOR(type, prefix) { \
321 prefix ## _stripped, \
322 prefix ## _redundancy, \
323 prefix ## _must_init, \
325 (HPT_UINT)(prefix ## _vbus_ext_size), \
327 (HPT_UINT)(prefix ## _dev_ext_size), \
328 (HPT_UINT)(prefix ## _cmd_ext_size), \
329 prefix ## _get_mem_info, \
330 prefix ## _queue_cmd, \
331 prefix ## _member_failed, \
332 prefix ## _initialize, \
333 prefix ## _release, \
337 prefix ## _sync_stamp, \
342 #define VD_PARTITION 4
344 #define mIsArray(vdev_type) ((vdev_type)>VD_PARTITION)
355 #define MAX_VD_TYPE_ID 12
357 struct vdev_class *ldm_find_vdev_class(HPT_U8 type);
359 typedef struct _VDEV {
361 struct vdev_class *Class;
367 HPT_UINT cmds_per_request;
372 HPT_PARTITION partition;
377 HPT_U8 vf_online : 1;
378 HPT_U8 vf_bootmark : 1;
379 HPT_U8 vf_bootable : 1;
380 HPT_U8 vf_resetting: 1;
381 HPT_U8 vf_quiesced: 1;
382 HPT_U8 vf_clslock: 1;
384 HPT_U8 cache_policy; /* see CACHE_POLICY_* */
389 struct list_head link;
390 struct list_head cq_wait_send;
391 struct list_head cq_sent;
395 struct list_head cq_wait_lock;
396 struct lock_request *locks_granted;
397 struct lock_request *locks_wait;
403 #define CACHE_POLICY_NONE 0
404 #define CACHE_POLICY_WRITE_THROUGH 1
405 #define CACHE_POLICY_WRITE_BACK 2
408 extern HIM *him_list;
411 void ldm_register_him(PHIM him);
414 void ldm_register_vdev_class(struct vdev_class *Class);
417 HPT_BOOL ldm_register_adapter(PLDM_ADAPTER adapter);
420 int init_config(void);
422 HPT_UINT ldm_get_vbus_size(void);
425 void ldm_create_vbus(PVBUS vbus, void *osext);
428 void ldm_get_mem_info(PVBUS vbus, void *osext);
431 void *ldm_get_vbus_ext(PVBUS vbus, struct vdev_class *Class);
434 PVBUS ldm_get_next_vbus(PVBUS vbus, void **posext);
436 #define ldm_for_each_vbus(vbus, vbus_ext) \
437 for (vbus = ldm_get_next_vbus(0, (void **)(void *)&vbus_ext); vbus; \
438 vbus = ldm_get_next_vbus(vbus, (void **)(void *)&vbus_ext))
441 void ldm_initialize_vbus_async(PVBUS vbus, PLDM_ADAPTER master_adapter, void (*done)(void *osext));
443 /* ldm_initialize_vbus is deprecated since it will hold the CPU too long. */
444 #define ldm_initialize_vbus(vbus, adapter) ldm_initialize_vbus_async(vbus, adapter, 0)
447 void ldm_release_vbus(PVBUS vbus);
449 PVDEV ldm_create_vdev(PVBUS vbus, HPT_U8 type);
450 void ldm_release_vdev(PVDEV vd);
452 PVDEV ldm_find_target(PVBUS vbus, int id);
453 PVDEV ldm_find_stamp(PVBUS vbus, HPT_U32 stamp, int seq);
456 PCOMMAND ldm_alloc_cmds(PVBUS vbus, HPT_UINT cnt);
457 void ldm_free_cmds(PCOMMAND cmd);
459 HPT_UINT ldm_get_cmd_size(void);
460 PCOMMAND ldm_alloc_cmds_from_list(PVBUS vbus, struct freelist *list, HPT_UINT cnt);
461 void ldm_free_cmds_to_list(struct freelist *list, PCOMMAND cmd);
464 PCOMMAND __ldm_alloc_cmd(struct freelist *list);
466 #ifdef OS_SUPPORT_TASK
467 #define CMD_SET_PRIORITY(cmd, pri) cmd->priority = (pri)
469 #define CMD_SET_PRIORITY(cmd, pri)
473 #define CMD_GROUP_GET(grp, cmd) \
475 grp->grplist->count++;\
476 cmd = __ldm_alloc_cmd(grp->grplist);\
477 cmd->vbus = grp->vbus;\
478 cmd->grplist = grp->grplist;\
479 CMD_SET_PRIORITY(cmd, grp->priority);\
482 #define CMD_GROUP_PUT(grp, cmd) \
484 freelist_put(grp->grplist, cmd);\
485 grp->grplist->count--;\
491 void ldm_queue_cmd(PCOMMAND cmd);
492 void vdev_queue_cmd(PCOMMAND cmd);
493 void ldm_finish_cmd(PCOMMAND cmd);
496 int ldm_acquire_lock(PVDEV vd, struct lock_request *req);
497 void ldm_release_lock(PVDEV vd, struct lock_request *req);
499 void ldm_queue_task(struct task_queue *tq, struct tq_item *t);
500 void ldm_queue_vbus_dpc(PVBUS vbus, struct tq_item *t);
502 HPT_BOOL ldm_intr(PVBUS vbus);
503 void ldm_run(PVBUS vbus);
504 int ldm_idle(PVBUS vbus);
507 int ldm_reset_vbus(PVBUS vbus);
510 void ldm_suspend(PVBUS vbus);
511 void ldm_resume(PVBUS vbus);
512 LDM_ADAPTER *ldm_resume_adapter(PVBUS vbus, PLDM_ADAPTER ldm_adapter);
513 void ldm_shutdown(PVBUS vbus);/*shutdown all the controllers*/
516 #define HIM_EVENT_DEVICE_REMOVED 1
517 #define HIM_EVENT_DEVICE_PLUGGED 2
518 #define HIM_EVENT_DEVICE_ERROR 3
519 #define HIM_EVENT_RESET_REQUIRED 4
520 #define HIM_EVENT_QUIESCE_DEVICE 5
521 #define HIM_EVENT_UNQUIESCE_DEVICE 6
522 #define HIM_EVENT_CONFIG_CHANGED 7
524 void ldm_event_notify(HPT_U32 event, void *arg1, void *arg2);
526 void log_sector_repair(PVDEV vd, int success, HPT_LBA lba, HPT_U16 nsectors);
528 void ldm_register_device(PVDEV vd);
529 void ldm_unregister_device(PVDEV vd);
531 PVBUS him_handle_to_vbus(void * him_handle);
532 void ldm_ide_fixstring (HPT_U8 *s, const int bytecount);
533 #if defined(__cplusplus)