spi.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

 
/*
 * Copyright (C) 2016, 2017 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 _DEV_SPI_SPI_H
#define _DEV_SPI_SPI_H
 
#include <linux/spi/spidev.h>
 
#include <rtems.h>
#include <rtems/seterr.h>
#include <rtems/thread.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef struct spi_ioc_transfer spi_ioc_transfer;
 
typedef struct spi_bus spi_bus;


#define SPI_BUS_OBTAIN _IO(SPI_IOC_MAGIC, 13)

#define SPI_BUS_RELEASE _IO(SPI_IOC_MAGIC, 23)

struct spi_bus {
  int (*transfer)(spi_bus *bus, const spi_ioc_transfer *msgs, uint32_t msg_count);

  int (*setup)(spi_bus *bus);

  void (*destroy)(spi_bus *bus);

  rtems_recursive_mutex mutex;

  uint32_t max_speed_hz;

  uint32_t speed_hz;

  bool cs_change;

  uint8_t cs;

  uint8_t bits_per_word;

  bool lsb_first;

  uint32_t mode;

  uint16_t delay_usecs;

  int (*ioctl)(spi_bus *bus, ioctl_command_t command, void *arg);
};

int spi_bus_init(spi_bus *bus);

spi_bus *spi_bus_alloc_and_init(size_t size);

void spi_bus_destroy(spi_bus *bus);

void spi_bus_destroy_and_free(spi_bus *bus);

int spi_bus_register(
  spi_bus *bus,
  const char *bus_path
);

 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _DEV_SPI_SPI_H */