6/sys/dev/rr232x/ldm.h

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