1 /* 2 * TI EDMA definitions 3 * 4 * Copyright (C) 2006-2013 Texas Instruments. 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms of the GNU General Public License as published by the 8 * Free Software Foundation; either version 2 of the License, or (at your 9 * option) any later version. 10 */ 11 12 /* 13 * This EDMA3 programming framework exposes two basic kinds of resource: 14 * 15 * Channel Triggers transfers, usually from a hardware event but 16 * also manually or by "chaining" from DMA completions. 17 * Each channel is coupled to a Parameter RAM (PaRAM) slot. 18 * 19 * Slot Each PaRAM slot holds a DMA transfer descriptor (PaRAM 20 * "set"), source and destination addresses, a link to a 21 * next PaRAM slot (if any), options for the transfer, and 22 * instructions for updating those addresses. There are 23 * more than twice as many slots as event channels. 24 * 25 * Each PaRAM set describes a sequence of transfers, either for one large 26 * buffer or for several discontiguous smaller buffers. An EDMA transfer 27 * is driven only from a channel, which performs the transfers specified 28 * in its PaRAM slot until there are no more transfers. When that last 29 * transfer completes, the "link" field may be used to reload the channel's 30 * PaRAM slot with a new transfer descriptor. 31 * 32 * The EDMA Channel Controller (CC) maps requests from channels into physical 33 * Transfer Controller (TC) requests when the channel triggers (by hardware 34 * or software events, or by chaining). The two physical DMA channels provided 35 * by the TCs are thus shared by many logical channels. 36 * 37 * DaVinci hardware also has a "QDMA" mechanism which is not currently 38 * supported through this interface. (DSP firmware uses it though.) 39 */ 40 41 #ifndef EDMA_H_ 42 #define EDMA_H_ 43 44 /* PaRAM slots are laid out like this */ 45 struct edmacc_param { 46 u32 opt; 47 u32 src; 48 u32 a_b_cnt; 49 u32 dst; 50 u32 src_dst_bidx; 51 u32 link_bcntrld; 52 u32 src_dst_cidx; 53 u32 ccnt; 54 } __packed; 55 56 /* fields in edmacc_param.opt */ 57 #define SAM BIT(0) 58 #define DAM BIT(1) 59 #define SYNCDIM BIT(2) 60 #define STATIC BIT(3) 61 #define EDMA_FWID (0x07 << 8) 62 #define TCCMODE BIT(11) 63 #define EDMA_TCC(t) ((t) << 12) 64 #define TCINTEN BIT(20) 65 #define ITCINTEN BIT(21) 66 #define TCCHEN BIT(22) 67 #define ITCCHEN BIT(23) 68 69 /*ch_status paramater of callback function possible values*/ 70 #define EDMA_DMA_COMPLETE 1 71 #define EDMA_DMA_CC_ERROR 2 72 #define EDMA_DMA_TC1_ERROR 3 73 #define EDMA_DMA_TC2_ERROR 4 74 75 enum dma_event_q { 76 EVENTQ_0 = 0, 77 EVENTQ_1 = 1, 78 EVENTQ_2 = 2, 79 EVENTQ_3 = 3, 80 EVENTQ_DEFAULT = -1 81 }; 82 83 #define EDMA_CTLR_CHAN(ctlr, chan) (((ctlr) << 16) | (chan)) 84 #define EDMA_CTLR(i) ((i) >> 16) 85 #define EDMA_CHAN_SLOT(i) ((i) & 0xffff) 86 87 #define EDMA_CHANNEL_ANY -1 /* for edma_alloc_channel() */ 88 #define EDMA_SLOT_ANY -1 /* for edma_alloc_slot() */ 89 #define EDMA_CONT_PARAMS_ANY 1001 90 #define EDMA_CONT_PARAMS_FIXED_EXACT 1002 91 #define EDMA_CONT_PARAMS_FIXED_NOT_EXACT 1003 92 93 #define EDMA_MAX_CC 2 94 95 struct edma; 96 97 struct edma *edma_get_data(struct device *edma_dev); 98 99 /* alloc/free DMA channels and their dedicated parameter RAM slots */ 100 int edma_alloc_channel(struct edma *cc, int channel, 101 void (*callback)(unsigned channel, u16 ch_status, void *data), 102 void *data, enum dma_event_q); 103 void edma_free_channel(struct edma *cc, unsigned channel); 104 105 /* alloc/free parameter RAM slots */ 106 int edma_alloc_slot(struct edma *cc, int slot); 107 void edma_free_slot(struct edma *cc, unsigned slot); 108 109 /* calls that operate on part of a parameter RAM slot */ 110 dma_addr_t edma_get_position(struct edma *cc, unsigned slot, bool dst); 111 void edma_link(struct edma *cc, unsigned from, unsigned to); 112 113 /* calls that operate on an entire parameter RAM slot */ 114 void edma_write_slot(struct edma *cc, unsigned slot, 115 const struct edmacc_param *params); 116 void edma_read_slot(struct edma *cc, unsigned slot, 117 struct edmacc_param *params); 118 119 /* channel control operations */ 120 int edma_start(struct edma *cc, unsigned channel); 121 void edma_stop(struct edma *cc, unsigned channel); 122 void edma_clean_channel(struct edma *cc, unsigned channel); 123 void edma_pause(struct edma *cc, unsigned channel); 124 void edma_resume(struct edma *cc, unsigned channel); 125 int edma_trigger_channel(struct edma *cc, unsigned channel); 126 127 void edma_assign_channel_eventq(struct edma *cc, unsigned channel, 128 enum dma_event_q eventq_no); 129 130 struct edma_rsv_info { 131 132 const s16 (*rsv_chans)[2]; 133 const s16 (*rsv_slots)[2]; 134 }; 135 136 /* platform_data for EDMA driver */ 137 struct edma_soc_info { 138 /* 139 * Default queue is expected to be a low-priority queue. 140 * This way, long transfers on the default queue started 141 * by the codec engine will not cause audio defects. 142 */ 143 enum dma_event_q default_queue; 144 145 /* Resource reservation for other cores */ 146 struct edma_rsv_info *rsv; 147 148 s8 (*queue_priority_mapping)[2]; 149 const s16 (*xbar_chans)[2]; 150 }; 151 152 #endif 153