1/* $Id: ldm.h,v 1.78 2010/05/10 10:08:46 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: releng/11.0/sys/dev/hptnr/ldm.h 284792 2015-06-25 06:15:08Z delphij $ 28 */ 29#include <dev/hptnr/hptnr_config.h> 30#ifndef _HPT_LDM_H_ 31#define _HPT_LDM_H_ 32 33#define VERMAGIC_LDM 75 34 35#if defined(__cplusplus) 36extern "C" { 37#endif 38 39 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) 43 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) 47 48 49#ifndef HPT_INTERFACE_VERSION 50#define HPT_INTERFACE_VERSION 0x02010000 51#endif 52 53#ifndef MAX_PARTITIONS_PER_DISK 54#define MAX_PARTITIONS_PER_DISK 4 55#endif 56 57#if defined(__MAX_PARTITIONS_PER_DISK) && MAX_PARTITIONS_PER_DISK > __MAX_PARTITIONS_PER_DISK 58#error "Please redefine MAX_PARTITIONS_PER_DISK!!!" 59#endif 60 61#define MAX(a,b) (((a)>(b))?(a):(b)) 62#define MIN(a,b) (((a)<(b))?(a):(b)) 63 64 65typedef char check_HPT_TIME_is_unsigned[ (HPT_TIME)(-1) > 0 ? 1 : -1 ]; 66 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) 69 70 71 72struct freelist { 73 int dma; 74 HPT_UINT alignment; 75 HPT_UINT count; 76 HPT_UINT size; 77 void * head; 78 struct freelist *next; 79#if DBG 80 char *tag; 81 HPT_UINT reserved_count; 82 #define freelist_debug_tag(list, _tag) (list)->tag = _tag 83#else 84 #define freelist_debug_tag(list, _tag) 85#endif 86}; 87 88 89void freelist_reserve(struct freelist *list, void *osext, HPT_UINT size, HPT_UINT count); 90 91void *freelist_get(struct freelist *); 92void freelist_put(struct freelist *, void *p); 93 94void freelist_reserve_dma(struct freelist *list, void *osext, HPT_UINT size, HPT_UINT alignment, HPT_UINT count); 95void *freelist_get_dma(struct freelist *, BUS_ADDRESS *busaddr); 96void freelist_put_dma(struct freelist *, void *p, BUS_ADDRESS busaddr); 97 98 99#define freelist_reserve_with_tag(list, osext, size, count) \ 100 do {\ 101 freelist_debug_tag(list, #list " at " __FILE__);\ 102 freelist_reserve(list, osext, (HPT_UINT)(size), (HPT_UINT)(count));\ 103 }while(0) 104 105#define freelist_reserve_dma_with_tag(list, osext, size, alignment, count) \ 106 do {\ 107 freelist_debug_tag(list, #list " at " __FILE__);\ 108 freelist_reserve_dma(list, osext, (HPT_UINT)(size), (HPT_UINT)(alignment), (HPT_UINT)(count));\ 109 }while(0) 110 111struct lock_request { 112 HPT_U64 start, end; 113 struct lock_request *next; 114 struct list_head waiters; /* blocked commands */ 115 struct tq_item callback; 116 int lock_cc; 117}; 118 119#define INIT_LOCK_REQUEST(req, _start, _end, _cb, _arg, _cc) \ 120 do {\ 121 (req)->next = 0;\ 122 (req)->start = _start;\ 123 (req)->end = _end;\ 124 INIT_TQ_ITEM(&(req)->callback, _cb, _arg);\ 125 INIT_LIST_HEAD(&(req)->waiters);\ 126 (req)->lock_cc = _cc;\ 127 } while (0) 128 129struct task_queue { 130 struct tq_item *head, *tail; 131}; 132 133#define TQ_EMPTY(tq) ((tq)->head==0) 134 135struct dmapool_order { 136 HPT_UINT npages; 137 struct tq_item wakeup_fn; 138 struct dmapool_order *next; 139}; 140 141struct dmapool_client { 142 void * handle; 143 HPT_UINT (*shrink)(void *handle, HPT_UINT npages); 144 int (*resume)(void *handle); 145 struct dmapool_client *next; 146}; 147 148typedef struct _VBUS * PVBUS; 149typedef struct _VDEV * PVDEV; 150 151 152void dmapool_register_client(PVBUS vbus, struct dmapool_client *client); 153 154 155void dmapool_active(PVBUS vbus); 156 157/* return 0 if the request is immediately satisfied, non-zero otherwise. */ 158int dmapool_make_order(PVBUS vbus, struct dmapool_order *order); 159 160 161void *dmapool_get_page(PVBUS vbus, BUS_ADDRESS *busaddr); 162void *dmapool_get_page_at(PVBUS vbus, void *p, BUS_ADDRESS *busaddr); 163void dmapool_put_page(PVBUS vbus, void *p, BUS_ADDRESS busaddr); 164void dmapool_init(PVBUS vbus); 165HPT_UINT dmapool_max_class_pages(PVBUS vbus); 166 167 168struct timer_call { 169 HPT_U32 interval; /*microseconds*/ 170 HPT_TIME expire_time; /*microseconds*/ 171 void (*proc)(void * arg); 172 void * arg; 173 struct timer_call ** pprev; 174 struct timer_call * next; 175}; 176 177#define ldm_init_timer(timer) do { (timer)->next=0; (timer)->pprev=0; } while (0) 178 179#define INIT_TIMER_CALL(timer, _interval, _proc, _arg) \ 180 do { \ 181 HPT_ASSERT((timer)->next==0 && (timer)->pprev==0);\ 182 (timer)->interval = _interval;\ 183 (timer)->proc = _proc;\ 184 (timer)->arg = _arg;\ 185 } while(0) 186 187void ldm_request_timer(PVBUS vbus, struct timer_call * tc); 188void ldm_remove_timer(PVBUS vbus, struct timer_call * tc); 189void ldm_on_timer(PVBUS vbus); 190 191 192typedef struct _LDM_ADAPTER 193{ 194 struct _LDM_ADAPTER *next; 195 HIM *him; 196 void *him_handle; 197 PVBUS vbus; 198 struct freelist freelist_dev; 199 int devid_start; 200 struct freelist freelist_plugged_dpc; 201 HPT_BOOL master; 202} 203LDM_ADAPTER, *PLDM_ADAPTER; 204 205typedef struct _IOCTL_ARG 206{ 207 struct list_head link; 208 PVBUS vbus; 209 HPT_U32 dwIoControlCode; 210 HPT_U32 nInBufferSize; 211 HPT_U32 nOutBufferSize; 212 void * lpInBuffer; 213 void * lpOutBuffer; 214 HPT_U32 *lpBytesReturned; 215 void * ioctl_cmnd; 216 void (* done)(struct _IOCTL_ARG *); 217 int result; /* HPT_IOCTL_RESULT_ */ 218 struct tq_item dpc; 219} IOCTL_ARG; 220 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) 226 227void ldm_ioctl( PVBUS vbus, IOCTL_ARG *IAPnt); 228void ldm_set_autorebuild(PVBUS vbus, int enable); 229HPT_U32 ldm_get_device_id(PVDEV vd); /* for ioctl */ 230 231#ifndef __HPT_RAW_LBA 232#define __HPT_RAW_LBA HPT_RAW_LBA 233#endif 234 235#include <dev/hptnr/array.h> 236 237typedef struct hpt_raw_disk 238{ 239#ifdef SUPPORT_ARRAY 240 PRAW_PARTITION raw_part_list; 241 __HPT_RAW_LBA max_available_capacity; 242 __HPT_RAW_LBA total_available_capacity; 243#endif 244 __HPT_RAW_LBA real_capacity; 245 __HPT_RAW_LBA head_position; 246 HPT_U32 logical_sector_size; 247 HPT_U8 logicalsectors_per_physicalsector; 248 HPT_U16 lowest_aligned; 249 HPT_U16 max_sectors_per_cmd; 250 HPT_U8 max_queue_depth; 251 HPT_U8 user_select_mode; 252 253 HPT_UINT uninitialized : 1; 254 HPT_UINT legacy_disk : 1; 255 HPT_UINT is_spare : 1; 256 HPT_UINT v3_format : 1; 257 HPT_UINT need_sync : 1; 258 HPT_UINT temp_spare : 1; 259 HPT_UINT need_check_array : 1; 260 HPT_UINT df_user_mode_set: 1; 261 262 HPT_UINT df_read_ahead_set: 1; 263 HPT_UINT enable_read_ahead : 1; 264 HPT_UINT df_write_cache_set: 1; 265 HPT_UINT enable_write_cache : 1; 266 HPT_UINT df_tcq_set: 1; 267 HPT_UINT enable_tcq : 1; 268 HPT_UINT df_ncq_set: 1; 269 HPT_UINT enable_ncq : 1; 270 271 HPT_UINT bad_sector : 1; 272 HPT_UINT df_sas : 1; 273 274 HIM * him; 275 int index; 276 PLDM_ADAPTER adapter; 277 void * phy_dev; 278 279 char model[40]; 280 281 struct tq_item reset_dpc; 282 int reset_pending; 283 284 struct tq_item fail_dpc; 285 int fail_pending; 286} 287HPT_RAW_DISK, *PHPT_RAW_DISK; 288 289struct vdev_class 290{ 291 struct vdev_class *next; 292 293 HPT_U8 __type; 294 HPT_U8 stripped; /* RAID0,3,5,6 */ 295 HPT_U8 redundancy; /* RAID1-1, RAID3/5-1, RAID6-2 */ 296 HPT_U8 must_init; /* RAID3,5,6 */ 297 HPT_U8 docache; 298 299 HPT_UINT vbus_ext_size; 300 HPT_UINT vbus_ext_offset; /* used by LDM */ 301 HPT_UINT dev_ext_size; 302 HPT_UINT cmd_ext_size; 303 304 305 void (*get_mem_info)(PVBUS vbus, void *osext, int phydev_count); 306 void (*queue_cmd)(PCOMMAND cmd); 307 void (*member_failed)(struct _VDEV * vd); 308 309 310 void (*initialize)(PVBUS vbus); 311 void (*release)(PVBUS vbus); 312 int (*add)(PVDEV vd); 313 void (*remove)(PVDEV vd); 314 void (*reset)(PVDEV vd); 315 void (*sync_stamp)(PVDEV vd); 316 int (*support_type)(int type); 317}; 318 319 320#define VDEV_CLASS_CONSTRUCTOR(type, prefix) { \ 321 0, \ 322 type, \ 323 prefix ## _stripped, \ 324 prefix ## _redundancy, \ 325 prefix ## _must_init, \ 326 0, \ 327 (HPT_UINT)(prefix ## _vbus_ext_size), \ 328 0, \ 329 (HPT_UINT)(prefix ## _dev_ext_size), \ 330 (HPT_UINT)(prefix ## _cmd_ext_size), \ 331 prefix ## _get_mem_info, \ 332 prefix ## _queue_cmd, \ 333 prefix ## _member_failed, \ 334 prefix ## _initialize, \ 335 prefix ## _release, \ 336 prefix ## _add, \ 337 prefix ## _remove, \ 338 prefix ## _reset, \ 339 prefix ## _sync_stamp, \ 340 0 \ 341} 342 343#define VD_RAW 1 344#define VD_PARTITION 4 345 346#define mIsArray(vdev_type) ((vdev_type)>VD_PARTITION) 347 348#define VD_RAID0 5 349#define VD_RAID1 6 350#define VD_JBOD 7 351#define VD_RAID5 8 352#define VD_RAID6 9 353#define VD_RAID3 10 354#define VD_RAID4 11 355#define VD_RAID1E 12 356 357#define MAX_VD_TYPE_ID 12 358 359struct vdev_class *ldm_find_vdev_class(HPT_U8 type); 360 361typedef struct _VDEV { 362 PVBUS vbus; 363 struct vdev_class *Class; 364 HPT_U8 type; 365 PVDEV parent; 366 void * ext; 367 HPT_U64 capacity; 368 int target_id; 369 HPT_UINT cmds_per_request; 370 371 union { 372#ifdef SUPPORT_ARRAY 373 HPT_ARRAY array; 374 HPT_PARTITION partition; 375#endif 376 HPT_RAW_DISK raw; 377 } u; 378 379 HPT_U8 vf_online : 1; 380 HPT_U8 vf_bootmark : 1; 381 HPT_U8 vf_bootable : 1; 382 HPT_U8 vf_resetting: 1; 383 HPT_U8 vf_quiesced: 1; 384 HPT_U8 vf_clslock: 1; 385 386 HPT_U8 cache_policy; /* see CACHE_POLICY_* */ 387 388 HPT_UINT cq_len; 389 HPT_UINT cmds_sent; 390 391 struct list_head link; 392 struct list_head cq_wait_send; 393 struct list_head cq_sent; 394 395 HPT_U32 last_active; 396 int cq_priority; 397 struct list_head cq_wait_lock; 398 struct lock_request *locks_granted; 399 struct lock_request *locks_wait; 400 HPT_U32 ioctl_id; 401 void * cc_ext; 402} 403VDEV; 404 405#define CACHE_POLICY_NONE 0 406#define CACHE_POLICY_WRITE_THROUGH 1 407#define CACHE_POLICY_WRITE_BACK 2 408 409 410extern HIM *him_list; 411 412 413void ldm_register_him(PHIM him); 414 415 416void ldm_register_vdev_class(struct vdev_class *Class); 417 418 419HPT_BOOL ldm_register_adapter(PLDM_ADAPTER adapter); 420 421 422int init_config(void); 423 424HPT_UINT ldm_get_vbus_size(void); 425 426 427void ldm_create_vbus(PVBUS vbus, void *osext); 428 429 430void ldm_get_mem_info(PVBUS vbus, void *osext); 431 432 433void *ldm_get_vbus_ext(PVBUS vbus, struct vdev_class *Class); 434 435 436PVBUS ldm_get_next_vbus(PVBUS vbus, void **posext); 437 438#define ldm_for_each_vbus(vbus, vbus_ext) \ 439 for (vbus = ldm_get_next_vbus(0, (void **)(void *)&vbus_ext); vbus; \ 440 vbus = ldm_get_next_vbus(vbus, (void **)(void *)&vbus_ext)) 441 442 443void ldm_initialize_vbus_async(PVBUS vbus, PLDM_ADAPTER master_adapter, void (*done)(void *osext)); 444 445/* ldm_initialize_vbus is deprecated since it will hold the CPU too long. */ 446#define ldm_initialize_vbus(vbus, adapter) ldm_initialize_vbus_async(vbus, adapter, 0) 447 448 449void ldm_release_vbus(PVBUS vbus); 450 451PVDEV ldm_create_vdev(PVBUS vbus, HPT_U8 type); 452void ldm_release_vdev(PVDEV vd); 453 454PVDEV ldm_find_target(PVBUS vbus, int id); 455PVDEV ldm_find_stamp(PVBUS vbus, HPT_U32 stamp, int seq); 456 457 458PCOMMAND ldm_alloc_cmds(PVBUS vbus, HPT_UINT cnt); 459void ldm_free_cmds(PCOMMAND cmd); 460 461HPT_UINT ldm_get_cmd_size(void); 462PCOMMAND ldm_alloc_cmds_from_list(PVBUS vbus, struct freelist *list, HPT_UINT cnt); 463void ldm_free_cmds_to_list(struct freelist *list, PCOMMAND cmd); 464 465 466PCOMMAND __ldm_alloc_cmd(struct freelist *list); 467 468#ifdef OS_SUPPORT_TASK 469#define CMD_SET_PRIORITY(cmd, pri) cmd->priority = (pri) 470#else 471#define CMD_SET_PRIORITY(cmd, pri) 472#endif 473 474 475#define CMD_GROUP_GET(grp, cmd) \ 476 do {\ 477 grp->grplist->count++;\ 478 cmd = __ldm_alloc_cmd(grp->grplist);\ 479 cmd->vbus = grp->vbus;\ 480 cmd->grplist = grp->grplist;\ 481 CMD_SET_PRIORITY(cmd, grp->priority);\ 482 } while(0) 483 484#define CMD_GROUP_PUT(grp, cmd) \ 485 do {\ 486 freelist_put(grp->grplist, cmd);\ 487 grp->grplist->count--;\ 488 } while (0) 489 490 491 492 493void ldm_queue_cmd(PCOMMAND cmd); 494void vdev_queue_cmd(PCOMMAND cmd); 495void ldm_finish_cmd(PCOMMAND cmd); 496 497 498int ldm_acquire_lock(PVDEV vd, struct lock_request *req); 499void ldm_release_lock(PVDEV vd, struct lock_request *req); 500 501void ldm_queue_task(struct task_queue *tq, struct tq_item *t); 502void ldm_queue_vbus_dpc(PVBUS vbus, struct tq_item *t); 503 504HPT_BOOL ldm_intr(PVBUS vbus); 505void ldm_run(PVBUS vbus); 506int ldm_idle(PVBUS vbus); 507 508 509int ldm_reset_vbus(PVBUS vbus); 510 511 512void ldm_suspend(PVBUS vbus); 513void ldm_resume(PVBUS vbus); 514LDM_ADAPTER *ldm_resume_adapter(PVBUS vbus, PLDM_ADAPTER ldm_adapter); 515void ldm_shutdown(PVBUS vbus);/*shutdown all the controllers*/ 516 517 518#define HIM_EVENT_DEVICE_REMOVED 1 519#define HIM_EVENT_DEVICE_PLUGGED 2 520#define HIM_EVENT_DEVICE_ERROR 3 521#define HIM_EVENT_RESET_REQUIRED 4 522#define HIM_EVENT_QUIESCE_DEVICE 5 523#define HIM_EVENT_UNQUIESCE_DEVICE 6 524#define HIM_EVENT_CONFIG_CHANGED 7 525 526void ldm_event_notify(HPT_U32 event, void *arg1, void *arg2); 527 528void log_sector_repair(PVDEV vd, int success, HPT_LBA lba, HPT_U16 nsectors); 529 530void ldm_register_device(PVDEV vd); 531void ldm_unregister_device(PVDEV vd); 532 533PVBUS him_handle_to_vbus(void * him_handle); 534void ldm_ide_fixstring (HPT_U8 *s, const int bytecount); 535#if defined(__cplusplus) 536} 537#endif 538#endif 539