drivers/scsi/isci/timers.h

   1 /*
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  33  *   * Redistributions of source code must retain the above copyright
  34  *     notice, this list of conditions and the following disclaimer.
  35  *   * Redistributions in binary form must reproduce the above copyright
  36  *     notice, this list of conditions and the following disclaimer in
  37  *     the documentation and/or other materials provided with the
  38  *     distribution.
  39  *   * Neither the name of Intel Corporation nor the names of its
  40  *     contributors may be used to endorse or promote products derived
  41  *     from this software without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  */
  55
  56 #if !defined(_SCI_TIMER_H_)
  57 #define _SCI_TIMER_H_
  58
  59 #include <linux/timer.h>
  60 #include <linux/types.h>
  61
  62 /***************************************************
  63  * isci_timer
  64  ***************************************************
  65  */
  66 /**
  67  * struct isci_timer_list - This class is the container for all isci_timer
  68  *    objects
  69  *
  70  *
  71  */
  72 struct isci_timer_list {
  73
  74         struct list_head timers;
  75 };
  76
  77 /**
  78  * struct isci_timer - This class represents the timer object used by SCIC. It
  79  *    wraps the Linux timer_list object.
  80  *
  81  *
  82  */
  83 struct isci_timer {
  84         int used;
  85         int stopped;
  86         int restart;
  87         int timeout_value;
  88         void *cookie;
  89         void (*timer_callback)(void *);
  90         struct list_head node;
  91         struct timer_list timer;
  92         struct isci_timer_list *parent;
  93         struct isci_host *isci_host;
  94 };
  95
  96 #define to_isci_timer(t)        \
  97         container_of(t, struct isci_timer, timer);
  98
  99 int isci_timer_list_construct(
 100         struct isci_timer_list *isci_timer_list,
 101         int timer_list_size);
 102
 103
 104 int isci_timer_list_destroy(
 105         struct isci_timer_list *isci_timer_list);
 106
 107 struct isci_timer *isci_timer_create(
 108         struct isci_timer_list *isci_timer_list,
 109         struct isci_host *isci_host,
 110         void *cookie,
 111         void (*timer_callback)(void *));
 112
 113 void isci_timer_free(
 114         struct isci_timer_list *isci_timer_list,
 115         struct isci_timer *isci_timer);
 116
 117 void isci_timer_start(
 118         struct isci_timer *isci_timer,
 119         unsigned long timeout);
 120
 121 void isci_timer_stop(
 122         struct isci_timer *isci_timer);
 123
 124
 125 #endif /* !defined (_SCI_TIMER_H_) */
 126