freebsd-dev/sys/dev/ice/ice_resmgr.h
Eric Joyner 71d104536b ice(4): Introduce new driver for Intel E800 Ethernet controllers
The ice(4) driver is the driver for the Intel E8xx series Ethernet
controllers; currently with codenames Columbiaville and
Columbia Park.

These new controllers support 100G speeds, as well as introducing
more queues, better virtualization support, and more offload
capabilities. Future work will enable virtual functions (like
in ixl(4)) and the other functionality outlined above.

For full functionality, the kernel should be compiled with
"device ice_ddp" like in the amd64 NOTES file, and/or
ice_ddp_load="YES" should be added to /boot/loader.conf so that
the DDP package file included in this commit can be downloaded
to the adapter. Otherwise, the adapter will fall back to a single
queue mode with limited functionality.

A man page for this driver will be forthcoming.

MFC after:	1 month
Relnotes:	yes
Sponsored by:	Intel Corporation
Differential Revision:	https://reviews.freebsd.org/D21959
2020-05-26 23:35:10 +00:00

112 lines
3.9 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause */
/* Copyright (c) 2020, Intel Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. Neither the name of the Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* 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$*/
/**
* @file ice_resmgr.h
* @brief Resource manager interface
*
* Defines an interface for managing PF hardware queues and interrupts for assigning them to
* hardware VSIs and VFs.
*
* For queue management:
* The total number of available Tx and Rx queues is not equal, so it is
* expected that each PF will allocate two ice_resmgr structures, one for Tx
* and one for Rx. These should be allocated in attach() prior to initializing
* VSIs, and destroyed in detach().
*
* For interrupt management:
* The PF allocates an ice_resmgr structure that does not allow scattered
* allocations since interrupt allocations must be contiguous.
*/
#ifndef _ICE_RESMGR_H_
#define _ICE_RESMGR_H_
#include <sys/param.h>
#include "ice_osdep.h"
#include <sys/bitstring.h>
/*
* For managing VSI queue allocations
*/
/* Hardware only supports a limited number of resources in scattered mode */
#define ICE_MAX_SCATTERED_QUEUES 16
/* Use highest value to indicate invalid resource mapping */
#define ICE_INVALID_RES_IDX 0xFFFF
/*
* Structures
*/
/**
* @struct ice_resmgr
* @brief Resource manager
*
* Represent resource allocations using a bitstring, where bit zero represents
* the first resource. If a particular bit is set this indicates that the
* resource has been allocated and is not free.
*/
struct ice_resmgr {
bitstr_t *resources;
u16 num_res;
bool contig_only;
};
/**
* @enum ice_resmgr_alloc_type
* @brief resource manager allocation types
*
* Enumeration of possible allocation types that can be used when
* assigning resources. For now, SCATTERED is only used with
* managing queue allocations.
*/
enum ice_resmgr_alloc_type {
ICE_RESMGR_ALLOC_INVALID = 0,
ICE_RESMGR_ALLOC_CONTIGUOUS,
ICE_RESMGR_ALLOC_SCATTERED
};
/* Public resource manager allocation functions */
int ice_resmgr_init(struct ice_resmgr *resmgr, u16 num_res);
int ice_resmgr_init_contig_only(struct ice_resmgr *resmgr, u16 num_res);
void ice_resmgr_destroy(struct ice_resmgr *resmgr);
/* Public resource assignment functions */
int ice_resmgr_assign_contiguous(struct ice_resmgr *resmgr, u16 *idx, u16 num_res);
int ice_resmgr_assign_scattered(struct ice_resmgr *resmgr, u16 *idx, u16 num_res);
/* Release resources */
void ice_resmgr_release_map(struct ice_resmgr *resmgr, u16 *idx, u16 num_res);
#endif /* _ICE_RESMGR_H_ */