1 /* $Id: ldm.h,v 1.78 2010/05/10 10:08:46 lcn Exp $ */
3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 * Copyright (C) 2005-2011 HighPoint Technologies, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <dev/hptnr/hptnr_config.h>
35 #define VERMAGIC_LDM 75
37 #if defined(__cplusplus)
42 #define __hpt_set_ver(x, v1, v2, v3, v4, v5) x ## _R_ ## v1 ## _ ## v2 ## _ ## v3 ## _ ## v4 ## _ ## v5
43 #define _hpt_set_ver(x, v1, v2, v3, v4, v5) __hpt_set_ver(x, v1, v2, v3, v4, v5)
44 #define hpt_set_ver(x) _hpt_set_ver(x, VERMAGIC_OSM, VERMAGIC_HIM, VERMAGIC_LDM, VERMAGIC_ARRAY, MAX_MEMBERS)
46 #define ldm_register_him hpt_set_ver(ldm_register_him)
47 #define ldm_register_vdev_class hpt_set_ver(ldm_register_vdev_class)
48 #define ldm_alloc_cmds hpt_set_ver(ldm_alloc_cmds)
51 #ifndef HPT_INTERFACE_VERSION
52 #define HPT_INTERFACE_VERSION 0x02010000
55 #ifndef MAX_PARTITIONS_PER_DISK
56 #define MAX_PARTITIONS_PER_DISK 4
59 #if defined(__MAX_PARTITIONS_PER_DISK) && MAX_PARTITIONS_PER_DISK > __MAX_PARTITIONS_PER_DISK
60 #error "Please redefine MAX_PARTITIONS_PER_DISK!!!"
64 typedef char check_HPT_TIME_is_unsigned[ (HPT_TIME)(-1) > 0 ? 1 : -1 ];
66 #define hpt_time_after_eq(a, b) ((int)(a) - (int)(b) >= 0)
67 #define hpt_time_after(a, b) ((int)(a) - (int)(b) > 0)
77 struct freelist *next;
80 HPT_UINT reserved_count;
81 #define freelist_debug_tag(list, _tag) (list)->tag = _tag
83 #define freelist_debug_tag(list, _tag)
88 void freelist_reserve(struct freelist *list, void *osext, HPT_UINT size, HPT_UINT count);
90 void *freelist_get(struct freelist *);
91 void freelist_put(struct freelist *, void *p);
93 void freelist_reserve_dma(struct freelist *list, void *osext, HPT_UINT size, HPT_UINT alignment, HPT_UINT count);
94 void *freelist_get_dma(struct freelist *, BUS_ADDRESS *busaddr);
95 void freelist_put_dma(struct freelist *, void *p, BUS_ADDRESS busaddr);
98 #define freelist_reserve_with_tag(list, osext, size, count) \
100 freelist_debug_tag(list, #list " at " __FILE__);\
101 freelist_reserve(list, osext, (HPT_UINT)(size), (HPT_UINT)(count));\
104 #define freelist_reserve_dma_with_tag(list, osext, size, alignment, count) \
106 freelist_debug_tag(list, #list " at " __FILE__);\
107 freelist_reserve_dma(list, osext, (HPT_UINT)(size), (HPT_UINT)(alignment), (HPT_UINT)(count));\
110 struct lock_request {
112 struct lock_request *next;
113 struct list_head waiters; /* blocked commands */
114 struct tq_item callback;
118 #define INIT_LOCK_REQUEST(req, _start, _end, _cb, _arg, _cc) \
121 (req)->start = _start;\
123 INIT_TQ_ITEM(&(req)->callback, _cb, _arg);\
124 INIT_LIST_HEAD(&(req)->waiters);\
125 (req)->lock_cc = _cc;\
129 struct tq_item *head, *tail;
132 #define TQ_EMPTY(tq) ((tq)->head==0)
134 struct dmapool_order {
136 struct tq_item wakeup_fn;
137 struct dmapool_order *next;
140 struct dmapool_client {
142 HPT_UINT (*shrink)(void *handle, HPT_UINT npages);
143 int (*resume)(void *handle);
144 struct dmapool_client *next;
147 typedef struct _VBUS * PVBUS;
148 typedef struct _VDEV * PVDEV;
151 void dmapool_register_client(PVBUS vbus, struct dmapool_client *client);
154 void dmapool_active(PVBUS vbus);
156 /* return 0 if the request is immediately satisfied, non-zero otherwise. */
157 int dmapool_make_order(PVBUS vbus, struct dmapool_order *order);
160 void *dmapool_get_page(PVBUS vbus, BUS_ADDRESS *busaddr);
161 void *dmapool_get_page_at(PVBUS vbus, void *p, BUS_ADDRESS *busaddr);
162 void dmapool_put_page(PVBUS vbus, void *p, BUS_ADDRESS busaddr);
163 void dmapool_init(PVBUS vbus);
164 HPT_UINT dmapool_max_class_pages(PVBUS vbus);
168 HPT_U32 interval; /*microseconds*/
169 HPT_TIME expire_time; /*microseconds*/
170 void (*proc)(void * arg);
172 struct timer_call ** pprev;
173 struct timer_call * next;
176 #define ldm_init_timer(timer) do { (timer)->next=0; (timer)->pprev=0; } while (0)
178 #define INIT_TIMER_CALL(timer, _interval, _proc, _arg) \
180 HPT_ASSERT((timer)->next==0 && (timer)->pprev==0);\
181 (timer)->interval = _interval;\
182 (timer)->proc = _proc;\
183 (timer)->arg = _arg;\
186 void ldm_request_timer(PVBUS vbus, struct timer_call * tc);
187 void ldm_remove_timer(PVBUS vbus, struct timer_call * tc);
188 void ldm_on_timer(PVBUS vbus);
191 typedef struct _LDM_ADAPTER
193 struct _LDM_ADAPTER *next;
197 struct freelist freelist_dev;
199 struct freelist freelist_plugged_dpc;
202 LDM_ADAPTER, *PLDM_ADAPTER;
204 typedef struct _IOCTL_ARG
206 struct list_head link;
208 HPT_U32 dwIoControlCode;
209 HPT_U32 nInBufferSize;
210 HPT_U32 nOutBufferSize;
213 HPT_U32 *lpBytesReturned;
215 void (* done)(struct _IOCTL_ARG *);
216 int result; /* HPT_IOCTL_RESULT_ */
220 #define HPT_IOCTL_RESULT_OK 0
221 #define HPT_IOCTL_RESULT_FAILED (-1)
222 #define HPT_IOCTL_RESULT_INVALID (-2)
223 #define HPT_IOCTL_RESULT_RETRY (-3)
224 #define HPT_IOCTL_RESULT_WRONG_VBUS (-4)
226 void ldm_ioctl( PVBUS vbus, IOCTL_ARG *IAPnt);
227 void ldm_set_autorebuild(PVBUS vbus, int enable);
228 HPT_U32 ldm_get_device_id(PVDEV vd); /* for ioctl */
230 #ifndef __HPT_RAW_LBA
231 #define __HPT_RAW_LBA HPT_RAW_LBA
234 #include <dev/hptnr/array.h>
236 typedef struct hpt_raw_disk
239 PRAW_PARTITION raw_part_list;
240 __HPT_RAW_LBA max_available_capacity;
241 __HPT_RAW_LBA total_available_capacity;
243 __HPT_RAW_LBA real_capacity;
244 __HPT_RAW_LBA head_position;
245 HPT_U32 logical_sector_size;
246 HPT_U8 logicalsectors_per_physicalsector;
247 HPT_U16 lowest_aligned;
248 HPT_U16 max_sectors_per_cmd;
249 HPT_U8 max_queue_depth;
250 HPT_U8 user_select_mode;
252 HPT_UINT uninitialized : 1;
253 HPT_UINT legacy_disk : 1;
254 HPT_UINT is_spare : 1;
255 HPT_UINT v3_format : 1;
256 HPT_UINT need_sync : 1;
257 HPT_UINT temp_spare : 1;
258 HPT_UINT need_check_array : 1;
259 HPT_UINT df_user_mode_set: 1;
261 HPT_UINT df_read_ahead_set: 1;
262 HPT_UINT enable_read_ahead : 1;
263 HPT_UINT df_write_cache_set: 1;
264 HPT_UINT enable_write_cache : 1;
265 HPT_UINT df_tcq_set: 1;
266 HPT_UINT enable_tcq : 1;
267 HPT_UINT df_ncq_set: 1;
268 HPT_UINT enable_ncq : 1;
270 HPT_UINT bad_sector : 1;
275 PLDM_ADAPTER adapter;
280 struct tq_item reset_dpc;
283 struct tq_item fail_dpc;
286 HPT_RAW_DISK, *PHPT_RAW_DISK;
290 struct vdev_class *next;
293 HPT_U8 stripped; /* RAID0,3,5,6 */
294 HPT_U8 redundancy; /* RAID1-1, RAID3/5-1, RAID6-2 */
295 HPT_U8 must_init; /* RAID3,5,6 */
298 HPT_UINT vbus_ext_size;
299 HPT_UINT vbus_ext_offset; /* used by LDM */
300 HPT_UINT dev_ext_size;
301 HPT_UINT cmd_ext_size;
304 void (*get_mem_info)(PVBUS vbus, void *osext, int phydev_count);
305 void (*queue_cmd)(PCOMMAND cmd);
306 void (*member_failed)(struct _VDEV * vd);
309 void (*initialize)(PVBUS vbus);
310 void (*release)(PVBUS vbus);
311 int (*add)(PVDEV vd);
312 void (*remove)(PVDEV vd);
313 void (*reset)(PVDEV vd);
314 void (*sync_stamp)(PVDEV vd);
315 int (*support_type)(int type);
319 #define VDEV_CLASS_CONSTRUCTOR(type, prefix) { \
322 prefix ## _stripped, \
323 prefix ## _redundancy, \
324 prefix ## _must_init, \
326 (HPT_UINT)(prefix ## _vbus_ext_size), \
328 (HPT_UINT)(prefix ## _dev_ext_size), \
329 (HPT_UINT)(prefix ## _cmd_ext_size), \
330 prefix ## _get_mem_info, \
331 prefix ## _queue_cmd, \
332 prefix ## _member_failed, \
333 prefix ## _initialize, \
334 prefix ## _release, \
338 prefix ## _sync_stamp, \
343 #define VD_PARTITION 4
345 #define mIsArray(vdev_type) ((vdev_type)>VD_PARTITION)
356 #define MAX_VD_TYPE_ID 12
358 struct vdev_class *ldm_find_vdev_class(HPT_U8 type);
360 typedef struct _VDEV {
362 struct vdev_class *Class;
368 HPT_UINT cmds_per_request;
373 HPT_PARTITION partition;
378 HPT_U8 vf_online : 1;
379 HPT_U8 vf_bootmark : 1;
380 HPT_U8 vf_bootable : 1;
381 HPT_U8 vf_resetting: 1;
382 HPT_U8 vf_quiesced: 1;
383 HPT_U8 vf_clslock: 1;
385 HPT_U8 cache_policy; /* see CACHE_POLICY_* */
390 struct list_head link;
391 struct list_head cq_wait_send;
392 struct list_head cq_sent;
396 struct list_head cq_wait_lock;
397 struct lock_request *locks_granted;
398 struct lock_request *locks_wait;
404 #define CACHE_POLICY_NONE 0
405 #define CACHE_POLICY_WRITE_THROUGH 1
406 #define CACHE_POLICY_WRITE_BACK 2
409 extern HIM *him_list;
412 void ldm_register_him(PHIM him);
415 void ldm_register_vdev_class(struct vdev_class *Class);
418 HPT_BOOL ldm_register_adapter(PLDM_ADAPTER adapter);
421 int init_config(void);
423 HPT_UINT ldm_get_vbus_size(void);
426 void ldm_create_vbus(PVBUS vbus, void *osext);
429 void ldm_get_mem_info(PVBUS vbus, void *osext);
432 void *ldm_get_vbus_ext(PVBUS vbus, struct vdev_class *Class);
435 PVBUS ldm_get_next_vbus(PVBUS vbus, void **posext);
437 #define ldm_for_each_vbus(vbus, vbus_ext) \
438 for (vbus = ldm_get_next_vbus(0, (void **)(void *)&vbus_ext); vbus; \
439 vbus = ldm_get_next_vbus(vbus, (void **)(void *)&vbus_ext))
442 void ldm_initialize_vbus_async(PVBUS vbus, PLDM_ADAPTER master_adapter, void (*done)(void *osext));
444 /* ldm_initialize_vbus is deprecated since it will hold the CPU too long. */
445 #define ldm_initialize_vbus(vbus, adapter) ldm_initialize_vbus_async(vbus, adapter, 0)
448 void ldm_release_vbus(PVBUS vbus);
450 PVDEV ldm_create_vdev(PVBUS vbus, HPT_U8 type);
451 void ldm_release_vdev(PVDEV vd);
453 PVDEV ldm_find_target(PVBUS vbus, int id);
454 PVDEV ldm_find_stamp(PVBUS vbus, HPT_U32 stamp, int seq);
457 PCOMMAND ldm_alloc_cmds(PVBUS vbus, HPT_UINT cnt);
458 void ldm_free_cmds(PCOMMAND cmd);
460 HPT_UINT ldm_get_cmd_size(void);
461 PCOMMAND ldm_alloc_cmds_from_list(PVBUS vbus, struct freelist *list, HPT_UINT cnt);
462 void ldm_free_cmds_to_list(struct freelist *list, PCOMMAND cmd);
465 PCOMMAND __ldm_alloc_cmd(struct freelist *list);
467 #ifdef OS_SUPPORT_TASK
468 #define CMD_SET_PRIORITY(cmd, pri) cmd->priority = (pri)
470 #define CMD_SET_PRIORITY(cmd, pri)
474 #define CMD_GROUP_GET(grp, cmd) \
476 grp->grplist->count++;\
477 cmd = __ldm_alloc_cmd(grp->grplist);\
478 cmd->vbus = grp->vbus;\
479 cmd->grplist = grp->grplist;\
480 CMD_SET_PRIORITY(cmd, grp->priority);\
483 #define CMD_GROUP_PUT(grp, cmd) \
485 freelist_put(grp->grplist, cmd);\
486 grp->grplist->count--;\
492 void ldm_queue_cmd(PCOMMAND cmd);
493 void vdev_queue_cmd(PCOMMAND cmd);
494 void ldm_finish_cmd(PCOMMAND cmd);
497 int ldm_acquire_lock(PVDEV vd, struct lock_request *req);
498 void ldm_release_lock(PVDEV vd, struct lock_request *req);
500 void ldm_queue_task(struct task_queue *tq, struct tq_item *t);
501 void ldm_queue_vbus_dpc(PVBUS vbus, struct tq_item *t);
503 HPT_BOOL ldm_intr(PVBUS vbus);
504 void ldm_run(PVBUS vbus);
505 int ldm_idle(PVBUS vbus);
508 int ldm_reset_vbus(PVBUS vbus);
511 void ldm_suspend(PVBUS vbus);
512 void ldm_resume(PVBUS vbus);
513 LDM_ADAPTER *ldm_resume_adapter(PVBUS vbus, PLDM_ADAPTER ldm_adapter);
514 void ldm_shutdown(PVBUS vbus);/*shutdown all the controllers*/
517 #define HIM_EVENT_DEVICE_REMOVED 1
518 #define HIM_EVENT_DEVICE_PLUGGED 2
519 #define HIM_EVENT_DEVICE_ERROR 3
520 #define HIM_EVENT_RESET_REQUIRED 4
521 #define HIM_EVENT_QUIESCE_DEVICE 5
522 #define HIM_EVENT_UNQUIESCE_DEVICE 6
523 #define HIM_EVENT_CONFIG_CHANGED 7
525 void ldm_event_notify(HPT_U32 event, void *arg1, void *arg2);
527 void log_sector_repair(PVDEV vd, int success, HPT_LBA lba, HPT_U16 nsectors);
529 void ldm_register_device(PVDEV vd);
530 void ldm_unregister_device(PVDEV vd);
532 PVBUS him_handle_to_vbus(void * him_handle);
533 void ldm_ide_fixstring (HPT_U8 *s, const int bytecount);
534 #if defined(__cplusplus)