ceph/src/spdk/lib/ftl/ftl_anm.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) Intel Corporation.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef FTL_ANM_H
  35 #define FTL_ANM_H
  36
  37 #include "spdk/thread.h"
  38 #include "ftl_ppa.h"
  39
  40 struct ftl_nvme_ctrlr;
  41 struct ftl_anm_event;
  42 struct spdk_ftl_dev;
  43
  44 typedef void (*ftl_anm_fn)(struct ftl_anm_event *event);
  45
  46 enum ftl_anm_range {
  47         FTL_ANM_RANGE_LBK,
  48         FTL_ANM_RANGE_CHK,
  49         FTL_ANM_RANGE_PU,
  50         FTL_ANM_RANGE_MAX,
  51 };
  52
  53 struct ftl_anm_event {
  54         /* Owner device */
  55         struct spdk_ftl_dev             *dev;
  56
  57         /* Start PPA */
  58         struct ftl_ppa                  ppa;
  59
  60         /* ANM range */
  61         enum ftl_anm_range              range;
  62 };
  63
  64 int     ftl_anm_init(struct spdk_thread *thread, spdk_ftl_fn cb, void *cb_arg);
  65 int     ftl_anm_free(spdk_ftl_fn cb, void *cb_arg);
  66 int     ftl_anm_register_device(struct spdk_ftl_dev *dev, ftl_anm_fn fn);
  67 void    ftl_anm_unregister_device(struct spdk_ftl_dev *dev);
  68 void    ftl_anm_event_complete(struct ftl_anm_event *event);
  69
  70 #endif /* FTL_ANM_H */