xref: /freebsd/sys/dev/isci/scil/sci_base_controller.c (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3  *
4  * This file is provided under a dual BSD/GPLv2 license.  When using or
5  * redistributing this file, you may do so under either license.
6  *
7  * GPL LICENSE SUMMARY
8  *
9  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of version 2 of the GNU General Public License as
13  * published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
23  * The full GNU General Public License is included in this distribution
24  * in the file called LICENSE.GPL.
25  *
26  * BSD LICENSE
27  *
28  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29  * All rights reserved.
30  *
31  * Redistribution and use in source and binary forms, with or without
32  * modification, are permitted provided that the following conditions
33  * are met:
34  *
35  *   * Redistributions of source code must retain the above copyright
36  *     notice, this list of conditions and the following disclaimer.
37  *   * Redistributions in binary form must reproduce the above copyright
38  *     notice, this list of conditions and the following disclaimer in
39  *     the documentation and/or other materials provided with the
40  *     distribution.
41  *
42  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53  */
54 
55 #include <sys/cdefs.h>
56 __FBSDID("$FreeBSD$");
57 
58 /**
59  * @file
60  *
61  * @brief This file contains the base controller method implementations and
62  *        any constants or structures private to the base controller object
63  *        or common to all controller derived objects.
64  */
65 
66 #include <dev/isci/scil/sci_base_controller.h>
67 #include <dev/isci/scil/sci_controller.h>
68 
69 //******************************************************************************
70 //* P U B L I C   M E T H O D S
71 //******************************************************************************
72 
73 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T sci_controller_get_memory_descriptor_list_handle(
74    SCI_CONTROLLER_HANDLE_T controller
75 )
76 {
77    SCI_BASE_CONTROLLER_T * this_controller = (SCI_BASE_CONTROLLER_T*)controller;
78    return (SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T) &this_controller->mdl;
79 }
80 
81 //******************************************************************************
82 //* P R O T E C T E D   M E T H O D S
83 //******************************************************************************
84 
85 void sci_base_controller_construct(
86    SCI_BASE_CONTROLLER_T               * this_controller,
87    SCI_BASE_LOGGER_T                   * logger,
88    SCI_BASE_STATE_T                    * state_table,
89    SCI_PHYSICAL_MEMORY_DESCRIPTOR_T    * mdes,
90    U32                                   mde_count,
91    SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T   next_mdl
92 )
93 {
94    sci_base_object_construct((SCI_BASE_OBJECT_T *)this_controller, logger);
95 
96    sci_base_state_machine_construct(
97       &this_controller->state_machine,
98       &this_controller->parent,
99       state_table,
100       SCI_BASE_CONTROLLER_STATE_INITIAL
101    );
102 
103    sci_base_mdl_construct(&this_controller->mdl, mdes, mde_count, next_mdl);
104 
105    sci_base_state_machine_start(&this_controller->state_machine);
106 }
107 
108