1/* 2 * Timer/Counter Unit (TC) registers. 3 * 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. 8 */ 9 10#ifndef __SOC_ATMEL_TCB_H 11#define __SOC_ATMEL_TCB_H 12 13#include <linux/compiler.h> 14#include <linux/list.h> 15 16/* 17 * Many 32-bit Atmel SOCs include one or more TC blocks, each of which holds 18 * three general-purpose 16-bit timers. These timers share one register bank. 19 * Depending on the SOC, each timer may have its own clock and IRQ, or those 20 * may be shared by the whole TC block. 21 * 22 * These TC blocks may have up to nine external pins: TCLK0..2 signals for 23 * clocks or clock gates, and per-timer TIOA and TIOB signals used for PWM 24 * or triggering. Those pins need to be set up for use with the TC block, 25 * else they will be used as GPIOs or for a different controller. 26 * 27 * Although we expect each TC block to have a platform_device node, those 28 * nodes are not what drivers bind to. Instead, they ask for a specific 29 * TC block, by number ... which is a common approach on systems with many 30 * timers. Then they use clk_get() and platform_get_irq() to get clock and 31 * IRQ resources. 32 */ 33 34struct clk; 35 36/** 37 * struct atmel_tcb_config - SoC data for a Timer/Counter Block 38 * @counter_width: size in bits of a timer counter register 39 * @has_gclk: boolean indicating if a timer counter has a generic clock 40 * @has_qdec: boolean indicating if a timer counter has a quadrature 41 * decoder. 42 */ 43struct atmel_tcb_config { 44 size_t counter_width; 45 bool has_gclk; 46 bool has_qdec; 47}; 48 49/** 50 * struct atmel_tc - information about a Timer/Counter Block 51 * @pdev: physical device 52 * @regs: mapping through which the I/O registers can be accessed 53 * @id: block id 54 * @tcb_config: configuration data from SoC 55 * @irq: irq for each of the three channels 56 * @clk: internal clock source for each of the three channels 57 * @node: list node, for tclib internal use 58 * @allocated: if already used, for tclib internal use 59 * 60 * On some platforms, each TC channel has its own clocks and IRQs, 61 * while on others, all TC channels share the same clock and IRQ. 62 * Drivers should clk_enable() all the clocks they need even though 63 * all the entries in @clk may point to the same physical clock. 64 * Likewise, drivers should request irqs independently for each 65 * channel, but they must use IRQF_SHARED in case some of the entries 66 * in @irq are actually the same IRQ. 67 */ 68struct atmel_tc { 69 struct platform_device *pdev; 70 void __iomem *regs; 71 int id; 72 const struct atmel_tcb_config *tcb_config; 73 int irq[3]; 74 struct clk *clk[3]; 75 struct clk *slow_clk; 76 struct list_head node; 77 bool allocated; 78}; 79 80extern struct atmel_tc *atmel_tc_alloc(unsigned block); 81extern void atmel_tc_free(struct atmel_tc *tc); 82 83/* platform-specific ATMEL_TC_TIMER_CLOCKx divisors (0 means 32KiHz) */ 84extern const u8 atmel_tc_divisors[5]; 85 86 87/* 88 * Two registers have block-wide controls. These are: configuring the three 89 * "external" clocks (or event sources) used by the timer channels; and 90 * synchronizing the timers by resetting them all at once. 91 * 92 * "External" can mean "external to chip" using the TCLK0, TCLK1, or TCLK2 93 * signals. Or, it can mean "external to timer", using the TIOA output from 94 * one of the other two timers that's being run in waveform mode. 95 */ 96 97#define ATMEL_TC_BCR 0xc0 /* TC Block Control Register */ 98#define ATMEL_TC_SYNC (1 << 0) /* synchronize timers */ 99 100#define ATMEL_TC_BMR 0xc4 /* TC Block Mode Register */ 101#define ATMEL_TC_TC0XC0S (3 << 0) /* external clock 0 source */ 102#define ATMEL_TC_TC0XC0S_TCLK0 (0 << 0) 103#define ATMEL_TC_TC0XC0S_NONE (1 << 0) 104#define ATMEL_TC_TC0XC0S_TIOA1 (2 << 0) 105#define ATMEL_TC_TC0XC0S_TIOA2 (3 << 0) 106#define ATMEL_TC_TC1XC1S (3 << 2) /* external clock 1 source */ 107#define ATMEL_TC_TC1XC1S_TCLK1 (0 << 2) 108#define ATMEL_TC_TC1XC1S_NONE (1 << 2) 109#define ATMEL_TC_TC1XC1S_TIOA0 (2 << 2) 110#define ATMEL_TC_TC1XC1S_TIOA2 (3 << 2) 111#define ATMEL_TC_TC2XC2S (3 << 4) /* external clock 2 source */ 112#define ATMEL_TC_TC2XC2S_TCLK2 (0 << 4) 113#define ATMEL_TC_TC2XC2S_NONE (1 << 4) 114#define ATMEL_TC_TC2XC2S_TIOA0 (2 << 4) 115#define ATMEL_TC_TC2XC2S_TIOA1 (3 << 4) 116 117 118/* 119 * Each TC block has three "channels", each with one counter and controls. 120 * 121 * Note that the semantics of ATMEL_TC_TIMER_CLOCKx (input clock selection 122 * when it's not "external") is silicon-specific. AT91 platforms use one 123 * set of definitions; AVR32 platforms use a different set. Don't hard-wire 124 * such knowledge into your code, use the global "atmel_tc_divisors" ... 125 * where index N is the divisor for clock N+1, else zero to indicate it uses 126 * the 32 KiHz clock. 127 * 128 * The timers can be chained in various ways, and operated in "waveform" 129 * generation mode (including PWM) or "capture" mode (to time events). In 130 * both modes, behavior can be configured in many ways. 131 * 132 * Each timer has two I/O pins, TIOA and TIOB. Waveform mode uses TIOA as a 133 * PWM output, and TIOB as either another PWM or as a trigger. Capture mode 134 * uses them only as inputs. 135 */ 136#define ATMEL_TC_CHAN(idx) ((idx)*0x40) 137#define ATMEL_TC_REG(idx, reg) (ATMEL_TC_CHAN(idx) + ATMEL_TC_ ## reg) 138 139#define ATMEL_TC_CCR 0x00 /* Channel Control Register */ 140#define ATMEL_TC_CLKEN (1 << 0) /* clock enable */ 141#define ATMEL_TC_CLKDIS (1 << 1) /* clock disable */ 142#define ATMEL_TC_SWTRG (1 << 2) /* software trigger */ 143 144#define ATMEL_TC_CMR 0x04 /* Channel Mode Register */ 145 146/* Both modes share some CMR bits */ 147#define ATMEL_TC_TCCLKS (7 << 0) /* clock source */ 148#define ATMEL_TC_TIMER_CLOCK1 (0 << 0) 149#define ATMEL_TC_TIMER_CLOCK2 (1 << 0) 150#define ATMEL_TC_TIMER_CLOCK3 (2 << 0) 151#define ATMEL_TC_TIMER_CLOCK4 (3 << 0) 152#define ATMEL_TC_TIMER_CLOCK5 (4 << 0) 153#define ATMEL_TC_XC0 (5 << 0) 154#define ATMEL_TC_XC1 (6 << 0) 155#define ATMEL_TC_XC2 (7 << 0) 156#define ATMEL_TC_CLKI (1 << 3) /* clock invert */ 157#define ATMEL_TC_BURST (3 << 4) /* clock gating */ 158#define ATMEL_TC_GATE_NONE (0 << 4) 159#define ATMEL_TC_GATE_XC0 (1 << 4) 160#define ATMEL_TC_GATE_XC1 (2 << 4) 161#define ATMEL_TC_GATE_XC2 (3 << 4) 162#define ATMEL_TC_WAVE (1 << 15) /* true = Waveform mode */ 163 164/* CAPTURE mode CMR bits */ 165#define ATMEL_TC_LDBSTOP (1 << 6) /* counter stops on RB load */ 166#define ATMEL_TC_LDBDIS (1 << 7) /* counter disable on RB load */ 167#define ATMEL_TC_ETRGEDG (3 << 8) /* external trigger edge */ 168#define ATMEL_TC_ETRGEDG_NONE (0 << 8) 169#define ATMEL_TC_ETRGEDG_RISING (1 << 8) 170#define ATMEL_TC_ETRGEDG_FALLING (2 << 8) 171#define ATMEL_TC_ETRGEDG_BOTH (3 << 8) 172#define ATMEL_TC_ABETRG (1 << 10) /* external trigger is TIOA? */ 173#define ATMEL_TC_CPCTRG (1 << 14) /* RC compare trigger enable */ 174#define ATMEL_TC_LDRA (3 << 16) /* RA loading edge (of TIOA) */ 175#define ATMEL_TC_LDRA_NONE (0 << 16) 176#define ATMEL_TC_LDRA_RISING (1 << 16) 177#define ATMEL_TC_LDRA_FALLING (2 << 16) 178#define ATMEL_TC_LDRA_BOTH (3 << 16) 179#define ATMEL_TC_LDRB (3 << 18) /* RB loading edge (of TIOA) */ 180#define ATMEL_TC_LDRB_NONE (0 << 18) 181#define ATMEL_TC_LDRB_RISING (1 << 18) 182#define ATMEL_TC_LDRB_FALLING (2 << 18) 183#define ATMEL_TC_LDRB_BOTH (3 << 18) 184 185/* WAVEFORM mode CMR bits */ 186#define ATMEL_TC_CPCSTOP (1 << 6) /* RC compare stops counter */ 187#define ATMEL_TC_CPCDIS (1 << 7) /* RC compare disables counter */ 188#define ATMEL_TC_EEVTEDG (3 << 8) /* external event edge */ 189#define ATMEL_TC_EEVTEDG_NONE (0 << 8) 190#define ATMEL_TC_EEVTEDG_RISING (1 << 8) 191#define ATMEL_TC_EEVTEDG_FALLING (2 << 8) 192#define ATMEL_TC_EEVTEDG_BOTH (3 << 8) 193#define ATMEL_TC_EEVT (3 << 10) /* external event source */ 194#define ATMEL_TC_EEVT_TIOB (0 << 10) 195#define ATMEL_TC_EEVT_XC0 (1 << 10) 196#define ATMEL_TC_EEVT_XC1 (2 << 10) 197#define ATMEL_TC_EEVT_XC2 (3 << 10) 198#define ATMEL_TC_ENETRG (1 << 12) /* external event is trigger */ 199#define ATMEL_TC_WAVESEL (3 << 13) /* waveform type */ 200#define ATMEL_TC_WAVESEL_UP (0 << 13) 201#define ATMEL_TC_WAVESEL_UPDOWN (1 << 13) 202#define ATMEL_TC_WAVESEL_UP_AUTO (2 << 13) 203#define ATMEL_TC_WAVESEL_UPDOWN_AUTO (3 << 13) 204#define ATMEL_TC_ACPA (3 << 16) /* RA compare changes TIOA */ 205#define ATMEL_TC_ACPA_NONE (0 << 16) 206#define ATMEL_TC_ACPA_SET (1 << 16) 207#define ATMEL_TC_ACPA_CLEAR (2 << 16) 208#define ATMEL_TC_ACPA_TOGGLE (3 << 16) 209#define ATMEL_TC_ACPC (3 << 18) /* RC compare changes TIOA */ 210#define ATMEL_TC_ACPC_NONE (0 << 18) 211#define ATMEL_TC_ACPC_SET (1 << 18) 212#define ATMEL_TC_ACPC_CLEAR (2 << 18) 213#define ATMEL_TC_ACPC_TOGGLE (3 << 18) 214#define ATMEL_TC_AEEVT (3 << 20) /* external event changes TIOA */ 215#define ATMEL_TC_AEEVT_NONE (0 << 20) 216#define ATMEL_TC_AEEVT_SET (1 << 20) 217#define ATMEL_TC_AEEVT_CLEAR (2 << 20) 218#define ATMEL_TC_AEEVT_TOGGLE (3 << 20) 219#define ATMEL_TC_ASWTRG (3 << 22) /* software trigger changes TIOA */ 220#define ATMEL_TC_ASWTRG_NONE (0 << 22) 221#define ATMEL_TC_ASWTRG_SET (1 << 22) 222#define ATMEL_TC_ASWTRG_CLEAR (2 << 22) 223#define ATMEL_TC_ASWTRG_TOGGLE (3 << 22) 224#define ATMEL_TC_BCPB (3 << 24) /* RB compare changes TIOB */ 225#define ATMEL_TC_BCPB_NONE (0 << 24) 226#define ATMEL_TC_BCPB_SET (1 << 24) 227#define ATMEL_TC_BCPB_CLEAR (2 << 24) 228#define ATMEL_TC_BCPB_TOGGLE (3 << 24) 229#define ATMEL_TC_BCPC (3 << 26) /* RC compare changes TIOB */ 230#define ATMEL_TC_BCPC_NONE (0 << 26) 231#define ATMEL_TC_BCPC_SET (1 << 26) 232#define ATMEL_TC_BCPC_CLEAR (2 << 26) 233#define ATMEL_TC_BCPC_TOGGLE (3 << 26) 234#define ATMEL_TC_BEEVT (3 << 28) /* external event changes TIOB */ 235#define ATMEL_TC_BEEVT_NONE (0 << 28) 236#define ATMEL_TC_BEEVT_SET (1 << 28) 237#define ATMEL_TC_BEEVT_CLEAR (2 << 28) 238#define ATMEL_TC_BEEVT_TOGGLE (3 << 28) 239#define ATMEL_TC_BSWTRG (3 << 30) /* software trigger changes TIOB */ 240#define ATMEL_TC_BSWTRG_NONE (0 << 30) 241#define ATMEL_TC_BSWTRG_SET (1 << 30) 242#define ATMEL_TC_BSWTRG_CLEAR (2 << 30) 243#define ATMEL_TC_BSWTRG_TOGGLE (3 << 30) 244 245#define ATMEL_TC_CV 0x10 /* counter Value */ 246#define ATMEL_TC_RA 0x14 /* register A */ 247#define ATMEL_TC_RB 0x18 /* register B */ 248#define ATMEL_TC_RC 0x1c /* register C */ 249 250#define ATMEL_TC_SR 0x20 /* status (read-only) */ 251/* Status-only flags */ 252#define ATMEL_TC_CLKSTA (1 << 16) /* clock enabled */ 253#define ATMEL_TC_MTIOA (1 << 17) /* TIOA mirror */ 254#define ATMEL_TC_MTIOB (1 << 18) /* TIOB mirror */ 255 256#define ATMEL_TC_IER 0x24 /* interrupt enable (write-only) */ 257#define ATMEL_TC_IDR 0x28 /* interrupt disable (write-only) */ 258#define ATMEL_TC_IMR 0x2c /* interrupt mask (read-only) */ 259 260/* Status and IRQ flags */ 261#define ATMEL_TC_COVFS (1 << 0) /* counter overflow */ 262#define ATMEL_TC_LOVRS (1 << 1) /* load overrun */ 263#define ATMEL_TC_CPAS (1 << 2) /* RA compare */ 264#define ATMEL_TC_CPBS (1 << 3) /* RB compare */ 265#define ATMEL_TC_CPCS (1 << 4) /* RC compare */ 266#define ATMEL_TC_LDRAS (1 << 5) /* RA loading */ 267#define ATMEL_TC_LDRBS (1 << 6) /* RB loading */ 268#define ATMEL_TC_ETRGS (1 << 7) /* external trigger */ 269#define ATMEL_TC_ALL_IRQ (ATMEL_TC_COVFS | ATMEL_TC_LOVRS | \ 270 ATMEL_TC_CPAS | ATMEL_TC_CPBS | \ 271 ATMEL_TC_CPCS | ATMEL_TC_LDRAS | \ 272 ATMEL_TC_LDRBS | ATMEL_TC_ETRGS) \ 273 /* all IRQs */ 274 275#endif 276