FreeBSD/Linux Kernel Cross Reference
sys/dev/isci/scil/scif_domain.h

     /*-
      * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
      *
      * This file is provided under a dual BSD/GPLv2 license.  When using or
      * redistributing this file, you may do so under either license.
      *
      * GPL LICENSE SUMMARY
      *
      * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
     *
     * This program is free software; you can redistribute it and/or modify
     * it under the terms of version 2 of the GNU General Public License as
     * published by the Free Software Foundation.
     *
     * This program is distributed in the hope that it will be useful, but
     * WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     * General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program; if not, write to the Free Software
     * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
     * The full GNU General Public License is included in this distribution
     * in the file called LICENSE.GPL.
     *
     * BSD LICENSE
     *
     * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
     * All rights reserved.
     *
     * Redistribution and use in source and binary forms, with or without
     * modification, are permitted provided that the following conditions
     * are met:
     *
     *   * Redistributions of source code must retain the above copyright
     *     notice, this list of conditions and the following disclaimer.
     *   * Redistributions in binary form must reproduce the above copyright
     *     notice, this list of conditions and the following disclaimer in
     *     the documentation and/or other materials provided with the
     *     distribution.
     *
     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     *
     * $FreeBSD$
     */
    #ifndef _SCIF_DOMAIN_H_
    #define _SCIF_DOMAIN_H_
    
    /**
     * @file
     *
     * @brief This file contains all of the interface methods that can be called
     *        by an SCI Framework user on the SAS/SATA domain object.
     */
    
    #ifdef __cplusplus
    extern "C" {
    #endif // __cplusplus
    
    #include <dev/isci/scil/sci_types.h>
    #include <dev/isci/scil/sci_status.h>
    #include <dev/isci/scil/intel_sas.h>
    
    
    /**
     * @brief This method enables the framework user to find the SCI Core Port
     *        object through which the supplied domain is accessed.
     *
     * @param[in]  domain This parameter specifies the framework domain object
     *             for which to return the corresponding SCI Core port object.
     *
     * @return Return a handle to the SCI Core port through which the supplied
     *         domain is accessed.
     * @retval SCI_INVALID_HANDLE This value is returned if the core port
     *         object can not be retrieved.
     */
    SCI_PORT_HANDLE_T scif_domain_get_scic_port_handle(
       SCI_DOMAIN_HANDLE_T  domain
    );
    
    /**
     * @brief This method will find and retrieve the device associated with the
     *        supplied SAS address if such a device exists.
     *
     * @param[in]  domain This parameter specifies the framework domain object
     *             on which to discover devices.
     * @param[in]  sas_address This parameter specifies the SAS address of the
     *             object to locate in this domain.
     *
    * @return Indicate if the device was successfully found in the domain.
    * @retval SCI_INVALID_HANDLE This value is returned if the device is not
    *         found in the domain.
    * @retval All other values indicate a valid remote device being found.
    */
   SCI_REMOTE_DEVICE_HANDLE_T scif_domain_get_device_by_sas_address(
      SCI_DOMAIN_HANDLE_T   domain,
      SCI_SAS_ADDRESS_T   * sas_address
   );
   
   /**
    * @brief This method will attempt to discover the supplied domain.
    *
    * @warning This method must be synchronized with the controller completion
    *          handler (see scic_controller_get_handler_methods()).  The user
    *          may call this method from within the completion handler in which
    *          case, no synchronization is necessary.
    *
    * @note
    *        - IO requests from the OS driver are held off until discovery
    *          of the domain is complete.
    *        - Discovery may perform SSP or STP IO requests to configure
    *          remote devices prior to informing the SCIF User of their
    *          existence via the remote_device_ready user callback.
    *
    * @param[in]  domain This parameter specifies the framework domain object
    *             on which to discover devices.
    * @param[in]  discover_timeout This parameter specifies the number of
    *             milliseconds in which the domain discovery operation should
    *             complete.
    * @param[in]  device_timeout This parameter specifies the number of
    *             milliseconds in which the device configuration and/or reset
    *             operations should complete.  Logically, the device_timeout
    *             parameter should be shorter then the domain_timeout value.
    *             Especially considering the domain could be made up of "n"
    *             different devices.
    *
    * @return Indicate if the discover operation started successfully.
    * @retval SCI_SUCCESS This value is returned if the discover operation
    *         started successfully.
    * @retval SCI_WARNING_TIMER_CONFLICT This value is returned if the SCI
    *         implementation doesn't support the desired timeout amounts or if
    *         the desired timeout amounts conflict in some manner.
    */
   SCI_STATUS scif_domain_discover(
      SCI_DOMAIN_HANDLE_T   domain,
      U32                   discover_timeout,
      U32                   device_timeout
   );
   
   #if !defined(DISABLE_SCI_ITERATORS)
   /**
    * @brief This method gets an iterator for the list of remote devices in the
    *        specified domain.
    *
    * @param[in] domain: This parameter specifies the framework domain handle
    * @param[in] iterator_buffer: This parameters specifies the memory buffer that
    *            will be used to construct the iterator.
    *
    * @retval Handle to the remote device list iterator.
    */
   SCI_ITERATOR_HANDLE_T scif_domain_get_remote_device_iterator(
      SCI_DOMAIN_HANDLE_T   domain,
      void                * iterator_buffer
   );
   #else // !defined(DISABLE_SCI_ITERATORS)
   #define scif_domain_get_remote_device_iterator(the_domain, the_buffer) \
           SCI_INVALID_HANDLE
   #endif // !defined(DISABLE_SCI_ITERATORS)
   
   /**
    * @brief This method simply returns a suggest timeout value for discovery.
    *
    * @param[in] domain The handle to the domain whose discover activity is to
    *     be started.
    *
    * @return The suggested timeout value for domain discover in milli-seconds.
    */
   U32 scif_domain_get_suggested_discover_timeout(
      SCI_DOMAIN_HANDLE_T   domain
   );
   
   #ifdef __cplusplus
   }
   #endif // __cplusplus
   
   #endif // _SCIF_DOMAIN_H_
   

Cache object: 3f4fb56184365b252e07436f7082f5ae