spivar.h revision 1.11
1 /* $NetBSD: spivar.h,v 1.11 2022/01/19 05:21:44 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 2006 Urbana-Champaign Independent Media Center. 5 * Copyright (c) 2006 Garrett D'Amore. 6 * All rights reserved. 7 * 8 * Portions of this code were written by Garrett D'Amore for the 9 * Champaign-Urbana Community Wireless Network Project. 10 * 11 * Redistribution and use in source and binary forms, with or 12 * without modification, are permitted provided that the following 13 * conditions are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above 17 * copyright notice, this list of conditions and the following 18 * disclaimer in the documentation and/or other materials provided 19 * with the distribution. 20 * 3. All advertising materials mentioning features or use of this 21 * software must display the following acknowledgements: 22 * This product includes software developed by the Urbana-Champaign 23 * Independent Media Center. 24 * This product includes software developed by Garrett D'Amore. 25 * 4. Urbana-Champaign Independent Media Center's name and Garrett 26 * D'Amore's name may not be used to endorse or promote products 27 * derived from this software without specific prior written permission. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE URBANA-CHAMPAIGN INDEPENDENT 30 * MEDIA CENTER AND GARRETT D'AMORE ``AS IS'' AND ANY EXPRESS OR 31 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 32 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 33 * ARE DISCLAIMED. IN NO EVENT SHALL THE URBANA-CHAMPAIGN INDEPENDENT 34 * MEDIA CENTER OR GARRETT D'AMORE BE LIABLE FOR ANY DIRECT, INDIRECT, 35 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 42 */ 43 44 #ifndef _DEV_SPI_SPIVAR_H_ 45 #define _DEV_SPI_SPIVAR_H_ 46 47 #include <sys/queue.h> 48 49 /* 50 * Serial Peripheral Interface bus. This is a 4-wire bus common for 51 * connecting flash, clocks, sensors, and various other low-speed 52 * peripherals. 53 */ 54 55 struct spi_handle; 56 struct spi_transfer; 57 58 /* 59 * De facto standard latching modes. 60 */ 61 #define SPI_MODE_0 0 /* CPOL = 0, CPHA = 0 */ 62 #define SPI_MODE_1 1 /* CPOL = 0, CPHA = 1 */ 63 #define SPI_MODE_2 2 /* CPOL = 1, CPHA = 0 */ 64 #define SPI_MODE_3 3 /* CPOL = 1, CPHA = 1 */ 65 /* Philips' Microwire is just Mode 0 */ 66 #define SPI_MODE_MICROWIRE SPI_MODE_0 67 68 struct spi_controller { 69 void *sct_cookie; /* controller private data */ 70 int sct_nslaves; 71 int (*sct_configure)(void *, int, int, int); 72 int (*sct_transfer)(void *, struct spi_transfer *); 73 }; 74 75 int spibus_print(void *, const char *); 76 77 /* one per chip select */ 78 struct spibus_attach_args { 79 struct spi_controller *sba_controller; 80 prop_array_t sba_child_devices; 81 }; 82 83 struct spi_attach_args { 84 struct spi_handle *sa_handle; 85 /* only set if using direct config */ 86 int sa_ncompat; /* number of pointers in the 87 ia_compat array */ 88 const char ** sa_compat; /* chip names */ 89 prop_dictionary_t sa_prop; /* dictionary for this device */ 90 91 uintptr_t sa_cookie; /* OF node in openfirmware machines */ 92 }; 93 94 /* 95 * This is similar in some respects to struct buf, but we cannot use 96 * that structure because it was not designed to support full-duplex 97 * IO. 98 */ 99 struct spi_chunk { 100 struct spi_chunk *chunk_next; 101 int chunk_count; 102 uint8_t *chunk_read; 103 const uint8_t *chunk_write; 104 /* for private use by framework and bus driver */ 105 uint8_t *chunk_rptr; 106 const uint8_t *chunk_wptr; 107 int chunk_rresid; 108 int chunk_wresid; 109 }; 110 111 struct spi_transfer { 112 struct spi_chunk *st_chunks; /* chained bufs */ 113 SIMPLEQ_ENTRY(spi_transfer) st_chain; /* chain of submitted jobs */ 114 volatile int st_flags; 115 int st_errno; 116 int st_slave; 117 void *st_private; 118 void (*st_done)(struct spi_transfer *); 119 kmutex_t st_lock; 120 kcondvar_t st_cv; 121 void *st_busprivate; 122 void *st_spiprivate; 123 }; 124 125 /* declare a list of transfers */ 126 SIMPLEQ_HEAD(spi_transq, spi_transfer); 127 128 #define spi_transq_init(q) \ 129 SIMPLEQ_INIT(q) 130 131 #define spi_transq_enqueue(q, trans) \ 132 SIMPLEQ_INSERT_TAIL(q, trans, st_chain) 133 134 #define spi_transq_dequeue(q) \ 135 SIMPLEQ_REMOVE_HEAD(q, st_chain) 136 137 #define spi_transq_first(q) \ 138 SIMPLEQ_FIRST(q) 139 140 #define SPI_F_DONE 0x0001 141 #define SPI_F_ERROR 0x0002 142 143 int spi_compatible_match(const struct spi_attach_args *, const cfdata_t, 144 const struct device_compatible_entry *); 145 int spi_configure(device_t, struct spi_handle *, int, int); 146 int spi_transfer(struct spi_handle *, struct spi_transfer *); 147 void spi_transfer_init(struct spi_transfer *); 148 void spi_chunk_init(struct spi_chunk *, int, const uint8_t *, uint8_t *); 149 void spi_transfer_add(struct spi_transfer *, struct spi_chunk *); 150 void spi_wait(struct spi_transfer *); 151 void spi_done(struct spi_transfer *, int); 152 153 /* convenience wrappers */ 154 int spi_send(struct spi_handle *, int, const uint8_t *); 155 int spi_recv(struct spi_handle *, int, uint8_t *); 156 int spi_send_recv(struct spi_handle *, int, const uint8_t *, int, uint8_t *); 157 158 #endif /* _DEV_SPI_SPIVAR_H_ */ 159
Indexes created Fri Sep 26 08:10:20 GMT 2025