diff options
Diffstat (limited to 'src/vendorcode/cavium/include/bdk/libbdk-driver/bdk-driver.h')
| -rw-r--r-- | src/vendorcode/cavium/include/bdk/libbdk-driver/bdk-driver.h | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/src/vendorcode/cavium/include/bdk/libbdk-driver/bdk-driver.h b/src/vendorcode/cavium/include/bdk/libbdk-driver/bdk-driver.h new file mode 100644 index 0000000000..c99b8ef959 --- /dev/null +++ b/src/vendorcode/cavium/include/bdk/libbdk-driver/bdk-driver.h @@ -0,0 +1,71 @@ +/***********************license start*********************************** +* Copyright (c) 2003-2017 Cavium Inc. (support@cavium.com). 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. +* +* * Neither the name of Cavium Inc. 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, including technical data, may be subject to U.S. export +* control laws, including the U.S. Export Administration Act and its +* associated regulations, and may be subject to export or import +* regulations in other countries. +* +* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" +* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR +* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT +* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY +* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT +* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES +* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR +* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, +* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK +* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. +***********************license end**************************************/ + +/** + * @file + * + * bdk_driver_t represents drivers for devices connected using + * ECAMs. This are discover by scanning the ECAMs and + * instantiating devices for what is found. + * + * @defgroup driver ECAM Attached Drivers + * @addtogroup driver + * @{ + */ +#include "bdk-driver-sgpio.h" + +/** + * Defines the main entry points for a device driver + */ +typedef struct bdk_driver_s +{ + struct bdk_driver_s *next; /* Used by bdk-device to maintian list */ + uint32_t id; /* ECAM device ID */ + int (*probe)(bdk_device_t *device); + int (*init)(bdk_device_t *device); +} bdk_driver_t; + +/** + * Called by the BDK to register all loaded drivers with bdk-device. + * + * @return Zero on success, negative on failure + */ +extern int __bdk_driver_register_all(void) BDK_WEAK; + +/** @} */ |