spi: davinci: add additional comments
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / arch / arm / mach-davinci / include / mach / spi.h
blob38f4da5ca135cfa32adeda31fc29bd27e04d8405
1 /*
2 * Copyright 2009 Texas Instruments.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 #ifndef __ARCH_ARM_DAVINCI_SPI_H
20 #define __ARCH_ARM_DAVINCI_SPI_H
22 #define SPI_INTERN_CS 0xFF
24 enum {
25 SPI_VERSION_1, /* For DM355/DM365/DM6467 */
26 SPI_VERSION_2, /* For DA8xx */
29 /**
30 * davinci_spi_platform_data - Platform data for SPI master device on DaVinci
32 * @version: version of the SPI IP. Different DaVinci devices have slightly
33 * varying versions of the same IP.
34 * @num_chipselect: number of chipselects supported by this SPI master
35 * @intr_line: interrupt line used to connect the SPI IP to the ARM interrupt
36 * controller withn the SoC. Possible values are 0 and 1.
37 * @chip_sel: list of GPIOs which can act as chip-selects for the SPI.
38 * SPI_INTERN_CS denotes internal SPI chip-select. Not necessary
39 * to populate if all chip-selects are internal.
40 * @cshold_bug: set this to true if the SPI controller on your chip requires
41 * a write to CSHOLD bit in between transfers (like in DM355).
43 struct davinci_spi_platform_data {
44 u8 version;
45 u8 num_chipselect;
46 u8 intr_line;
47 u8 *chip_sel;
48 bool cshold_bug;
51 /**
52 * davinci_spi_config - Per-chip-select configuration for SPI slave devices
54 * @wdelay: amount of delay between transmissions. Measured in number of
55 * SPI module clocks.
56 * @odd_parity: polarity of parity flag at the end of transmit data stream.
57 * 0 - odd parity, 1 - even parity.
58 * @parity_enable: enable transmission of parity at end of each transmit
59 * data stream.
60 * @io_type: type of IO transfer. Choose between polled, interrupt and DMA.
61 * @timer_disable: disable chip-select timers (setup and hold)
62 * @c2tdelay: chip-select setup time. Measured in number of SPI module clocks.
63 * @t2cdelay: chip-select hold time. Measured in number of SPI module clocks.
64 * @t2edelay: transmit data finished to SPI ENAn pin inactive time. Measured
65 * in number of SPI clocks.
66 * @c2edelay: chip-select active to SPI ENAn signal active time. Measured in
67 * number of SPI clocks.
69 struct davinci_spi_config {
70 u8 wdelay;
71 u8 odd_parity;
72 u8 parity_enable;
73 #define SPI_IO_TYPE_INTR 0
74 #define SPI_IO_TYPE_POLL 1
75 #define SPI_IO_TYPE_DMA 2
76 u8 io_type;
77 u8 timer_disable;
78 u8 c2tdelay;
79 u8 t2cdelay;
80 u8 t2edelay;
81 u8 c2edelay;
84 #endif /* __ARCH_ARM_DAVINCI_SPI_H */