xref: /freebsd/sys/dev/isci/scil/sci_base_controller.c (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
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  *
40  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51  */
52 
53 #include <sys/cdefs.h>
54 __FBSDID("$FreeBSD$");
55 
56 /**
57  * @file
58  *
59  * @brief This file contains the base controller method implementations and
60  *        any constants or structures private to the base controller object
61  *        or common to all controller derived objects.
62  */
63 
64 #include <dev/isci/scil/sci_base_controller.h>
65 #include <dev/isci/scil/sci_controller.h>
66 
67 //******************************************************************************
68 //* P U B L I C   M E T H O D S
69 //******************************************************************************
70 
71 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T sci_controller_get_memory_descriptor_list_handle(
72    SCI_CONTROLLER_HANDLE_T controller
73 )
74 {
75    SCI_BASE_CONTROLLER_T * this_controller = (SCI_BASE_CONTROLLER_T*)controller;
76    return (SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T) &this_controller->mdl;
77 }
78 
79 //******************************************************************************
80 //* P R O T E C T E D   M E T H O D S
81 //******************************************************************************
82 
83 void sci_base_controller_construct(
84    SCI_BASE_CONTROLLER_T               * this_controller,
85    SCI_BASE_LOGGER_T                   * logger,
86    SCI_BASE_STATE_T                    * state_table,
87    SCI_PHYSICAL_MEMORY_DESCRIPTOR_T    * mdes,
88    U32                                   mde_count,
89    SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T   next_mdl
90 )
91 {
92    sci_base_object_construct((SCI_BASE_OBJECT_T *)this_controller, logger);
93 
94    sci_base_state_machine_construct(
95       &this_controller->state_machine,
96       &this_controller->parent,
97       state_table,
98       SCI_BASE_CONTROLLER_STATE_INITIAL
99    );
100 
101    sci_base_mdl_construct(&this_controller->mdl, mdes, mde_count, next_mdl);
102 
103    sci_base_state_machine_start(&this_controller->state_machine);
104 }
105 
106