dev/spi/imx-spi-gpio.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSDeviceIMXSPIGPIO
0007  *
0008  * @brief This header file provides the interfaces of
0009  *   @ref RTEMSDeviceIMXSPIGPIO.
0010  */
0011
0012 /*
0013  * Copyright (C) 2024 embedded brains GmbH & Co. KG
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_DEV_SPI_IMX_SPI_GPIO_H
0038 #define _RTEMS_DEV_SPI_IMX_SPI_GPIO_H
0039
0040 #include <rtems.h>
0041
0042 #ifdef __cplusplus
0043 extern "C" {
0044 #endif /* __cplusplus */
0045
0046 /**
0047  * @defgroup RTEMSDeviceIMXSPIGPIO
0048  *
0049  * @ingroup RTEMSDeviceSPIGPIO
0050  *
0051  * @brief A SPI bus driver that uses the i.MX/i.MXRT GPIO pins
0052  *
0053  * @{
0054  */
0055
0056 /**
0057  * @brief Register all compatible nodes from the device tree.
0058  *
0059  * Search nodes in the device tree that are compatible to 'spi-gpio' and try to
0060  * register the driver for them. Expects a node that looks (for example) like
0061  * the following:
0062  *
0063  * ```
0064  * gpiospi: spi {
0065  *  status = "okay";
0066  *  compatible = "spi-gpio";
0067  *  #address-cells = <0x1>;
0068  *  #size-cells = <0x0>;
0069  *
0070  *  sck-gpios = <&gpio2 27 0>;
0071  *  miso-gpios = <&gpio2 25 0>;
0072  *  mosi-gpios = <&gpio4 14 0>;
0073  *  cs-gpios = <&gpio4 10 1>;
0074  *  num-chipselects = <1>;
0075  *
0076  *  rtems,path = "/dev/gpiospi";
0077  * };
0078  * ```
0079  */
0080 rtems_status_code imx_spi_gpio_init(void);
0081
0082 /** @} */
0083
0084 #ifdef __cplusplus
0085 }
0086 #endif /* __cplusplus */
0087
0088 #endif /* _RTEMS_DEV_SPI_IMX_SPI_GPIO_H */