1 /* $Id: ldm.h,v 1.78 2010/05/10 10:08:46 lcn Exp $ */ 2 /*- 3 * SPDX-License-Identifier: BSD-2-Clause 4 * 5 * Copyright (C) 2005-2011 HighPoint Technologies, Inc. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 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. 16 * 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 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD$ 30 */ 31 #include <dev/hptnr/hptnr_config.h> 32 #ifndef _HPT_LDM_H_ 33 #define _HPT_LDM_H_ 34 35 #define VERMAGIC_LDM 75 36 37 #if defined(__cplusplus) 38 extern "C" { 39 #endif 40 41 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) 45 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) 49 50 51 #ifndef HPT_INTERFACE_VERSION 52 #define HPT_INTERFACE_VERSION 0x02010000 53 #endif 54 55 #ifndef MAX_PARTITIONS_PER_DISK 56 #define MAX_PARTITIONS_PER_DISK 4 57 #endif 58 59 #if defined(__MAX_PARTITIONS_PER_DISK) && MAX_PARTITIONS_PER_DISK > __MAX_PARTITIONS_PER_DISK 60 #error "Please redefine MAX_PARTITIONS_PER_DISK!!!" 61 #endif 62 63 64 typedef char check_HPT_TIME_is_unsigned[ (HPT_TIME)(-1) > 0 ? 1 : -1 ]; 65 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) 68 69 70 71 struct freelist { 72 int dma; 73 HPT_UINT alignment; 74 HPT_UINT count; 75 HPT_UINT size; 76 void * head; 77 struct freelist *next; 78 #if DBG 79 char *tag; 80 HPT_UINT reserved_count; 81 #define freelist_debug_tag(list, _tag) (list)->tag = _tag 82 #else 83 #define freelist_debug_tag(list, _tag) 84 #endif 85 }; 86 87 88 void freelist_reserve(struct freelist *list, void *osext, HPT_UINT size, HPT_UINT count); 89 90 void *freelist_get(struct freelist *); 91 void freelist_put(struct freelist *, void *p); 92 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); 96 97 98 #define freelist_reserve_with_tag(list, osext, size, count) \ 99 do {\ 100 freelist_debug_tag(list, #list " at " __FILE__);\ 101 freelist_reserve(list, osext, (HPT_UINT)(size), (HPT_UINT)(count));\ 102 }while(0) 103 104 #define freelist_reserve_dma_with_tag(list, osext, size, alignment, count) \ 105 do {\ 106 freelist_debug_tag(list, #list " at " __FILE__);\ 107 freelist_reserve_dma(list, osext, (HPT_UINT)(size), (HPT_UINT)(alignment), (HPT_UINT)(count));\ 108 }while(0) 109 110 struct lock_request { 111 HPT_U64 start, end; 112 struct lock_request *next; 113 struct list_head waiters; /* blocked commands */ 114 struct tq_item callback; 115 int lock_cc; 116 }; 117 118 #define INIT_LOCK_REQUEST(req, _start, _end, _cb, _arg, _cc) \ 119 do {\ 120 (req)->next = 0;\ 121 (req)->start = _start;\ 122 (req)->end = _end;\ 123 INIT_TQ_ITEM(&(req)->callback, _cb, _arg);\ 124 INIT_LIST_HEAD(&(req)->waiters);\ 125 (req)->lock_cc = _cc;\ 126 } while (0) 127 128 struct task_queue { 129 struct tq_item *head, *tail; 130 }; 131 132 #define TQ_EMPTY(tq) ((tq)->head==0) 133 134 struct dmapool_order { 135 HPT_UINT npages; 136 struct tq_item wakeup_fn; 137 struct dmapool_order *next; 138 }; 139 140 struct dmapool_client { 141 void * handle; 142 HPT_UINT (*shrink)(void *handle, HPT_UINT npages); 143 int (*resume)(void *handle); 144 struct dmapool_client *next; 145 }; 146 147 typedef struct _VBUS * PVBUS; 148 typedef struct _VDEV * PVDEV; 149 150 151 void dmapool_register_client(PVBUS vbus, struct dmapool_client *client); 152 153 154 void dmapool_active(PVBUS vbus); 155 156 /* return 0 if the request is immediately satisfied, non-zero otherwise. */ 157 int dmapool_make_order(PVBUS vbus, struct dmapool_order *order); 158 159 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); 165 166 167 struct timer_call { 168 HPT_U32 interval; /*microseconds*/ 169 HPT_TIME expire_time; /*microseconds*/ 170 void (*proc)(void * arg); 171 void * arg; 172 struct timer_call ** pprev; 173 struct timer_call * next; 174 }; 175 176 #define ldm_init_timer(timer) do { (timer)->next=0; (timer)->pprev=0; } while (0) 177 178 #define INIT_TIMER_CALL(timer, _interval, _proc, _arg) \ 179 do { \ 180 HPT_ASSERT((timer)->next==0 && (timer)->pprev==0);\ 181 (timer)->interval = _interval;\ 182 (timer)->proc = _proc;\ 183 (timer)->arg = _arg;\ 184 } while(0) 185 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); 189 190 191 typedef struct _LDM_ADAPTER 192 { 193 struct _LDM_ADAPTER *next; 194 HIM *him; 195 void *him_handle; 196 PVBUS vbus; 197 struct freelist freelist_dev; 198 int devid_start; 199 struct freelist freelist_plugged_dpc; 200 HPT_BOOL master; 201 } 202 LDM_ADAPTER, *PLDM_ADAPTER; 203 204 typedef struct _IOCTL_ARG 205 { 206 struct list_head link; 207 PVBUS vbus; 208 HPT_U32 dwIoControlCode; 209 HPT_U32 nInBufferSize; 210 HPT_U32 nOutBufferSize; 211 void * lpInBuffer; 212 void * lpOutBuffer; 213 HPT_U32 *lpBytesReturned; 214 void * ioctl_cmnd; 215 void (* done)(struct _IOCTL_ARG *); 216 int result; /* HPT_IOCTL_RESULT_ */ 217 struct tq_item dpc; 218 } IOCTL_ARG; 219 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) 225 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 */ 229 230 #ifndef __HPT_RAW_LBA 231 #define __HPT_RAW_LBA HPT_RAW_LBA 232 #endif 233 234 #include <dev/hptnr/array.h> 235 236 typedef struct hpt_raw_disk 237 { 238 #ifdef SUPPORT_ARRAY 239 PRAW_PARTITION raw_part_list; 240 __HPT_RAW_LBA max_available_capacity; 241 __HPT_RAW_LBA total_available_capacity; 242 #endif 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; 251 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; 260 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; 269 270 HPT_UINT bad_sector : 1; 271 HPT_UINT df_sas : 1; 272 273 HIM * him; 274 int index; 275 PLDM_ADAPTER adapter; 276 void * phy_dev; 277 278 char model[40]; 279 280 struct tq_item reset_dpc; 281 int reset_pending; 282 283 struct tq_item fail_dpc; 284 int fail_pending; 285 } 286 HPT_RAW_DISK, *PHPT_RAW_DISK; 287 288 struct vdev_class 289 { 290 struct vdev_class *next; 291 292 HPT_U8 __type; 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 */ 296 HPT_U8 docache; 297 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; 302 303 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); 307 308 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); 316 }; 317 318 319 #define VDEV_CLASS_CONSTRUCTOR(type, prefix) { \ 320 0, \ 321 type, \ 322 prefix ## _stripped, \ 323 prefix ## _redundancy, \ 324 prefix ## _must_init, \ 325 0, \ 326 (HPT_UINT)(prefix ## _vbus_ext_size), \ 327 0, \ 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, \ 335 prefix ## _add, \ 336 prefix ## _remove, \ 337 prefix ## _reset, \ 338 prefix ## _sync_stamp, \ 339 0 \ 340 } 341 342 #define VD_RAW 1 343 #define VD_PARTITION 4 344 345 #define mIsArray(vdev_type) ((vdev_type)>VD_PARTITION) 346 347 #define VD_RAID0 5 348 #define VD_RAID1 6 349 #define VD_JBOD 7 350 #define VD_RAID5 8 351 #define VD_RAID6 9 352 #define VD_RAID3 10 353 #define VD_RAID4 11 354 #define VD_RAID1E 12 355 356 #define MAX_VD_TYPE_ID 12 357 358 struct vdev_class *ldm_find_vdev_class(HPT_U8 type); 359 360 typedef struct _VDEV { 361 PVBUS vbus; 362 struct vdev_class *Class; 363 HPT_U8 type; 364 PVDEV parent; 365 void * ext; 366 HPT_U64 capacity; 367 int target_id; 368 HPT_UINT cmds_per_request; 369 370 union { 371 #ifdef SUPPORT_ARRAY 372 HPT_ARRAY array; 373 HPT_PARTITION partition; 374 #endif 375 HPT_RAW_DISK raw; 376 } u; 377 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; 384 385 HPT_U8 cache_policy; /* see CACHE_POLICY_* */ 386 387 HPT_UINT cq_len; 388 HPT_UINT cmds_sent; 389 390 struct list_head link; 391 struct list_head cq_wait_send; 392 struct list_head cq_sent; 393 394 HPT_U32 last_active; 395 int cq_priority; 396 struct list_head cq_wait_lock; 397 struct lock_request *locks_granted; 398 struct lock_request *locks_wait; 399 HPT_U32 ioctl_id; 400 void * cc_ext; 401 } 402 VDEV; 403 404 #define CACHE_POLICY_NONE 0 405 #define CACHE_POLICY_WRITE_THROUGH 1 406 #define CACHE_POLICY_WRITE_BACK 2 407 408 409 extern HIM *him_list; 410 411 412 void ldm_register_him(PHIM him); 413 414 415 void ldm_register_vdev_class(struct vdev_class *Class); 416 417 418 HPT_BOOL ldm_register_adapter(PLDM_ADAPTER adapter); 419 420 421 int init_config(void); 422 423 HPT_UINT ldm_get_vbus_size(void); 424 425 426 void ldm_create_vbus(PVBUS vbus, void *osext); 427 428 429 void ldm_get_mem_info(PVBUS vbus, void *osext); 430 431 432 void *ldm_get_vbus_ext(PVBUS vbus, struct vdev_class *Class); 433 434 435 PVBUS ldm_get_next_vbus(PVBUS vbus, void **posext); 436 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)) 440 441 442 void ldm_initialize_vbus_async(PVBUS vbus, PLDM_ADAPTER master_adapter, void (*done)(void *osext)); 443 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) 446 447 448 void ldm_release_vbus(PVBUS vbus); 449 450 PVDEV ldm_create_vdev(PVBUS vbus, HPT_U8 type); 451 void ldm_release_vdev(PVDEV vd); 452 453 PVDEV ldm_find_target(PVBUS vbus, int id); 454 PVDEV ldm_find_stamp(PVBUS vbus, HPT_U32 stamp, int seq); 455 456 457 PCOMMAND ldm_alloc_cmds(PVBUS vbus, HPT_UINT cnt); 458 void ldm_free_cmds(PCOMMAND cmd); 459 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); 463 464 465 PCOMMAND __ldm_alloc_cmd(struct freelist *list); 466 467 #ifdef OS_SUPPORT_TASK 468 #define CMD_SET_PRIORITY(cmd, pri) cmd->priority = (pri) 469 #else 470 #define CMD_SET_PRIORITY(cmd, pri) 471 #endif 472 473 474 #define CMD_GROUP_GET(grp, cmd) \ 475 do {\ 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);\ 481 } while(0) 482 483 #define CMD_GROUP_PUT(grp, cmd) \ 484 do {\ 485 freelist_put(grp->grplist, cmd);\ 486 grp->grplist->count--;\ 487 } while (0) 488 489 490 491 492 void ldm_queue_cmd(PCOMMAND cmd); 493 void vdev_queue_cmd(PCOMMAND cmd); 494 void ldm_finish_cmd(PCOMMAND cmd); 495 496 497 int ldm_acquire_lock(PVDEV vd, struct lock_request *req); 498 void ldm_release_lock(PVDEV vd, struct lock_request *req); 499 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); 502 503 HPT_BOOL ldm_intr(PVBUS vbus); 504 void ldm_run(PVBUS vbus); 505 int ldm_idle(PVBUS vbus); 506 507 508 int ldm_reset_vbus(PVBUS vbus); 509 510 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*/ 515 516 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 524 525 void ldm_event_notify(HPT_U32 event, void *arg1, void *arg2); 526 527 void log_sector_repair(PVDEV vd, int success, HPT_LBA lba, HPT_U16 nsectors); 528 529 void ldm_register_device(PVDEV vd); 530 void ldm_unregister_device(PVDEV vd); 531 532 PVBUS him_handle_to_vbus(void * him_handle); 533 void ldm_ide_fixstring (HPT_U8 *s, const int bytecount); 534 #if defined(__cplusplus) 535 } 536 #endif 537 #endif 538