spi-gpio.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2024 embedded brains GmbH & Co. KG
 *
 * 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.
 *
 * 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.
 */
 
#ifndef _RTEMS_DEV_SPI_SPI_GPIO_H
#define _RTEMS_DEV_SPI_SPI_GPIO_H
 
#include <rtems.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define SPI_GPIO_MAX_CS 4
 
typedef void (spi_gpio_set_pin_fn) (void *arg, bool level);
 
typedef bool (spi_gpio_get_pin_fn) (void *arg);
 
struct spi_gpio_params {
  spi_gpio_set_pin_fn *set_clk;
  void *set_clk_arg;
  spi_gpio_set_pin_fn *set_mosi;
  void *set_mosi_arg;
  spi_gpio_get_pin_fn *get_miso;
  void *get_miso_arg;
  spi_gpio_set_pin_fn *set_cs[SPI_GPIO_MAX_CS];
  void *set_cs_arg[SPI_GPIO_MAX_CS];
 
  bool cs_idle[SPI_GPIO_MAX_CS];
};
 
rtems_status_code spi_gpio_init(
    const char *device,
    const struct spi_gpio_params *params
  );
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _RTEMS_DEV_SPI_SPI_GPIO_H */