spidev.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (c) 2016 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 _UAPI_LINUX_SPI_H
#define _UAPI_LINUX_SPI_H
 
#include <sys/ioccom.h>
#include <stddef.h>
#include <stdint.h>
 
#define SPI_CPHA 0x01
 
#define SPI_CPOL 0x02
 
#define SPI_MODE_0 0
 
#define SPI_MODE_1 SPI_CPHA
 
#define SPI_MODE_2 SPI_CPOL
 
#define SPI_MODE_3 (SPI_CPOL | SPI_CPHA)
 
#define SPI_CS_HIGH 0x04
 
#define SPI_LSB_FIRST 0x08
 
#define SPI_3WIRE 0x10
 
#define SPI_LOOP 0x20
 
#define SPI_NO_CS 0x40
 
#define SPI_READY 0x80
 
#define SPI_TX_DUAL 0x100
 
#define SPI_TX_QUAD 0x200
 
#define SPI_RX_DUAL 0x400
 
#define SPI_RX_QUAD 0x800
 
#define SPI_IOC_MAGIC 's'
 
struct spi_ioc_transfer {
  void *rx_buf;
 
  const void *tx_buf;
 
  size_t len;
 
  uint32_t speed_hz;
 
  uint16_t delay_usecs;
 
  uint8_t bits_per_word;
 
  uint8_t cs_change;
 
  uint8_t rx_nbits;
 
  uint8_t tx_nbits;
 
  uint32_t mode;
 
  uint8_t cs;
};
 
#define SPI_MSGSIZE(n) \
  (((n) * sizeof(struct spi_ioc_transfer) < IOCPARM_MAX) ? \
    (n) * sizeof(struct spi_ioc_transfer) : 0)
 
#define SPI_IOC_MESSAGE(n) _IOW(SPI_IOC_MAGIC, 0, char[SPI_MSGSIZE(n)])
 
#define SPI_IOC_RD_MODE _IOR(SPI_IOC_MAGIC, 1, uint8_t)
 
#define SPI_IOC_WR_MODE _IOW(SPI_IOC_MAGIC, 1, uint8_t)
 
#define SPI_IOC_RD_LSB_FIRST _IOR(SPI_IOC_MAGIC, 2, uint8_t)
 
#define SPI_IOC_WR_LSB_FIRST _IOW(SPI_IOC_MAGIC, 2, uint8_t)
 
#define SPI_IOC_RD_BITS_PER_WORD _IOR(SPI_IOC_MAGIC, 3, uint8_t)
 
#define SPI_IOC_WR_BITS_PER_WORD _IOW(SPI_IOC_MAGIC, 3, uint8_t)
 
#define SPI_IOC_RD_MAX_SPEED_HZ _IOR(SPI_IOC_MAGIC, 4, uint32_t)
 
#define SPI_IOC_WR_MAX_SPEED_HZ _IOW(SPI_IOC_MAGIC, 4, uint32_t)
 
#define SPI_IOC_RD_MODE32 _IOR(SPI_IOC_MAGIC, 5, uint32_t)
 
#define SPI_IOC_WR_MODE32 _IOW(SPI_IOC_MAGIC, 5, uint32_t)
 
#endif /* _UAPI_LINUX_SPI_H */