Orange Pi5 kernel

Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards

3 Commits   0 Branches   0 Tags
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   1) /* SPDX-License-Identifier: GPL-2.0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   2) #ifndef __SOUND_AZT3328_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   3) #define __SOUND_AZT3328_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   4) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   5) /* "PU" == "power-up value", as tested on PCI168 PCI rev. 10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   6)  * "WRITE_ONLY"  == register does not indicate actual bit values */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   7) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   8) /*** main I/O area port indices ***/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   9) /* (only 0x70 of 0x80 bytes saved/restored by Windows driver) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  10) #define AZF_IO_SIZE_CTRL	0x80
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  11) #define AZF_IO_SIZE_CTRL_PM	0x70
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  12) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  13) /* the driver initialisation suggests a layout of 4 areas
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  14)  * within the main card control I/O:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  15)  * from 0x00 (playback codec), from 0x20 (recording codec)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  16)  * and from 0x40 (most certainly I2S out codec).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  17)  * And another area from 0x60 to 0x6f (DirectX timer, IRQ management,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  18)  * power management etc.???). */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  19) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  20) #define AZF_IO_OFFS_CODEC_PLAYBACK	0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  21) #define AZF_IO_OFFS_CODEC_CAPTURE	0x20
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  22) #define AZF_IO_OFFS_CODEC_I2S_OUT	0x40
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  23) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  24) #define IDX_IO_CODEC_DMA_FLAGS       0x00 /* PU:0x0000 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  25)      /* able to reactivate output after output muting due to 8/16bit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  26)       * output change, just like 0x0002.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  27)       * 0x0001 is the only bit that's able to start the DMA counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  28)   #define DMA_RESUME			0x0001 /* paused if cleared? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  29)      /* 0x0002 *temporarily* set during DMA stopping. hmm
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  30)       * both 0x0002 and 0x0004 set in playback setup. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  31)      /* able to reactivate output after output muting due to 8/16bit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  32)       * output change, just like 0x0001. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  33)   #define DMA_RUN_SOMETHING1		0x0002 /* \ alternated (toggled) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  34)      /* 0x0004: NOT able to reactivate output */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  35)   #define DMA_RUN_SOMETHING2		0x0004 /* / bits */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  36)   #define SOMETHING_ALMOST_ALWAYS_SET	0x0008 /* ???; can be modified */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  37)   #define DMA_EPILOGUE_SOMETHING	0x0010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  38)   #define DMA_SOMETHING_ELSE		0x0020 /* ??? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  39)   #define SOMETHING_UNMODIFIABLE	0xffc0 /* unused? not modifiable */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  40) #define IDX_IO_CODEC_IRQTYPE     0x02 /* PU:0x0001 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  41)   /* write back to flags in case flags are set, in order to ACK IRQ in handler
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  42)    * (bit 1 of port 0x64 indicates interrupt for one of these three types)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  43)    * sometimes in this case it just writes 0xffff to globally ACK all IRQs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  44)    * settings written are not reflected when reading back, though.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  45)    * seems to be IRQ, too (frequently used: port |= 0x07 !), but who knows? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  46)   #define IRQ_SOMETHING			0x0001 /* something & ACK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  47)   #define IRQ_FINISHED_DMABUF_1		0x0002 /* 1st dmabuf finished & ACK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  48)   #define IRQ_FINISHED_DMABUF_2		0x0004 /* 2nd dmabuf finished & ACK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  49)   #define IRQMASK_SOME_STATUS_1		0x0008 /* \ related bits */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  50)   #define IRQMASK_SOME_STATUS_2		0x0010 /* / (checked together in loop) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  51)   #define IRQMASK_UNMODIFIABLE		0xffe0 /* unused? not modifiable */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  52)   /* start address of 1st DMA transfer area, PU:0x00000000 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  53) #define IDX_IO_CODEC_DMA_START_1 0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  54)   /* start address of 2nd DMA transfer area, PU:0x00000000 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  55) #define IDX_IO_CODEC_DMA_START_2 0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  56)   /* both lengths of DMA transfer areas, PU:0x00000000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  57)      length1: offset 0x0c, length2: offset 0x0e */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  58) #define IDX_IO_CODEC_DMA_LENGTHS 0x0c
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  59) #define IDX_IO_CODEC_DMA_CURRPOS 0x10 /* current DMA position, PU:0x00000000 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  60)   /* offset within current DMA transfer area, PU:0x0000 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  61) #define IDX_IO_CODEC_DMA_CURROFS 0x14
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  62) #define IDX_IO_CODEC_SOUNDFORMAT 0x16 /* PU:0x0010 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  63)   /* all unspecified bits can't be modified */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  64)   #define SOUNDFORMAT_FREQUENCY_MASK	0x000f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  65)   #define SOUNDFORMAT_XTAL1		0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  66)   #define SOUNDFORMAT_XTAL2		0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  67)     /* all _SUSPECTED_ values are not used by Windows drivers, so we don't
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  68)      * have any hard facts, only rough measurements.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  69)      * All we know is that the crystal used on the board has 24.576MHz,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  70)      * like many soundcards (which results in the frequencies below when
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  71)      * using certain divider values selected by the values below) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  72)     #define SOUNDFORMAT_FREQ_SUSPECTED_4000	0x0c | SOUNDFORMAT_XTAL1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  73)     #define SOUNDFORMAT_FREQ_SUSPECTED_4800	0x0a | SOUNDFORMAT_XTAL1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  74)     #define SOUNDFORMAT_FREQ_5510		0x0c | SOUNDFORMAT_XTAL2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  75)     #define SOUNDFORMAT_FREQ_6620		0x0a | SOUNDFORMAT_XTAL2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  76)     #define SOUNDFORMAT_FREQ_8000		0x00 | SOUNDFORMAT_XTAL1 /* also 0x0e | SOUNDFORMAT_XTAL1? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  77)     #define SOUNDFORMAT_FREQ_9600		0x08 | SOUNDFORMAT_XTAL1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  78)     #define SOUNDFORMAT_FREQ_11025		0x00 | SOUNDFORMAT_XTAL2 /* also 0x0e | SOUNDFORMAT_XTAL2? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  79)     #define SOUNDFORMAT_FREQ_SUSPECTED_13240	0x08 | SOUNDFORMAT_XTAL2 /* seems to be 6620 *2 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  80)     #define SOUNDFORMAT_FREQ_16000		0x02 | SOUNDFORMAT_XTAL1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  81)     #define SOUNDFORMAT_FREQ_22050		0x02 | SOUNDFORMAT_XTAL2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  82)     #define SOUNDFORMAT_FREQ_32000		0x04 | SOUNDFORMAT_XTAL1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  83)     #define SOUNDFORMAT_FREQ_44100		0x04 | SOUNDFORMAT_XTAL2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  84)     #define SOUNDFORMAT_FREQ_48000		0x06 | SOUNDFORMAT_XTAL1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  85)     #define SOUNDFORMAT_FREQ_SUSPECTED_66200	0x06 | SOUNDFORMAT_XTAL2 /* 66200 (13240 * 5); 64000 may have been nicer :-\ */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  86)   #define SOUNDFORMAT_FLAG_16BIT	0x0010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  87)   #define SOUNDFORMAT_FLAG_2CHANNELS	0x0020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  88) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  89) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  90) /* define frequency helpers, for maximum value safety */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  91) enum azf_freq_t {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  92) #define AZF_FREQ(rate) AZF_FREQ_##rate = rate
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  93)   AZF_FREQ(4000),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  94)   AZF_FREQ(4800),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  95)   AZF_FREQ(5512),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  96)   AZF_FREQ(6620),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  97)   AZF_FREQ(8000),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  98)   AZF_FREQ(9600),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  99)   AZF_FREQ(11025),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)   AZF_FREQ(13240),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)   AZF_FREQ(16000),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)   AZF_FREQ(22050),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103)   AZF_FREQ(32000),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)   AZF_FREQ(44100),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105)   AZF_FREQ(48000),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)   AZF_FREQ(66200),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) #undef AZF_FREQ
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) /** DirectX timer, main interrupt area (FIXME: and something else?) **/ 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) #define IDX_IO_TIMER_VALUE	0x60 /* found this timer area by pure luck :-) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)   /* timer countdown value; triggers IRQ when timer is finished */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)   #define TIMER_VALUE_MASK		0x000fffffUL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)   /* activate timer countdown */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)   #define TIMER_COUNTDOWN_ENABLE	0x01000000UL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)   /* trigger timer IRQ on zero transition */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)   #define TIMER_IRQ_ENABLE		0x02000000UL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)   /* being set in IRQ handler in case port 0x00 (hmm, not port 0x64!?!?)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)    * had 0x0020 set upon IRQ handler */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)   #define TIMER_IRQ_ACK			0x04000000UL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define IDX_IO_IRQSTATUS        0x64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)   /* some IRQ bit in here might also be used to signal a power-management timer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123)    * timeout, to request shutdown of the chip (e.g. AD1815JS has such a thing).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)    * OPL3 hardware contains several timers which confusingly in most cases
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)    * are NOT routed to an IRQ, but some designs (e.g. LM4560) DO support that,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)    * so I wouldn't be surprised at all to discover that AZF3328
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127)    * supports that thing as well... */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)   #define IRQ_PLAYBACK	0x0001
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)   #define IRQ_RECORDING	0x0002
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)   #define IRQ_I2S_OUT	0x0004 /* this IS I2S, right!? (untested) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)   #define IRQ_GAMEPORT	0x0008 /* Interrupt of Digital(ly) Enhanced Game Port */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133)   #define IRQ_MPU401	0x0010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)   #define IRQ_TIMER	0x0020 /* DirectX timer */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135)   #define IRQ_UNKNOWN2	0x0040 /* probably unused, or possibly OPL3 timer? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)   #define IRQ_UNKNOWN3	0x0080 /* probably unused, or possibly OPL3 timer? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) #define IDX_IO_66H		0x66    /* writing 0xffff returns 0x0000 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)   /* this is set to e.g. 0x3ff or 0x300, and writable;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139)    * maybe some buffer limit, but I couldn't find out more, PU:0x00ff: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) #define IDX_IO_SOME_VALUE	0x68
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)   #define IO_68_RANDOM_TOGGLE1	0x0100	/* toggles randomly */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142)   #define IO_68_RANDOM_TOGGLE2	0x0200	/* toggles randomly */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)   /* umm, nope, behaviour of these bits changes depending on what we wrote
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)    * to 0x6b!!
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145)    * And they change upon playback/stop, too:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146)    * Writing a value to 0x68 will display this exact value during playback,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)    * too but when stopped it can fall back to a rather different
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)    * seemingly random value). Hmm, possibly this is a register which
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)    * has a remote shadow which needs proper device supply which only exists
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)    * in case playback is active? Or is this driver-induced?
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)    */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) /* this WORD can be set to have bits 0x0028 activated (FIXME: correct??);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154)  * actually inhibits PCM playback!!! maybe power management??: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) #define IDX_IO_6AH		0x6A /* WRITE_ONLY! */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156)   /* bit 5: enabling this will activate permanent counting of bytes 2/3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157)    * at gameport I/O (0xb402/3) (equal values each) and cause
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158)    * gameport legacy I/O at 0x0200 to be _DISABLED_!
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159)    * Is this Digital Enhanced Game Port Enable??? Or maybe it's Testmode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)    * for Enhanced Digital Gameport (see 4D Wave DX card): */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161)   #define IO_6A_SOMETHING1_GAMEPORT	0x0020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162)   /* bit 8; sure, this _pauses_ playback (later resumes at same spot!),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)    * but what the heck is this really about??: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164)   #define IO_6A_PAUSE_PLAYBACK_BIT8	0x0100
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)   /* bit 9; sure, this _pauses_ playback (later resumes at same spot!),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166)    * but what the heck is this really about??: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167)   #define IO_6A_PAUSE_PLAYBACK_BIT9	0x0200
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) 	/* BIT8 and BIT9 are _NOT_ able to affect OPL3 MIDI playback,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) 	 * thus it suggests influence on PCM only!!
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) 	 * However OTOH there seems to be no bit anywhere around here
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) 	 * which is able to disable OPL3... */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172)   /* bit 10: enabling this actually changes values at legacy gameport
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173)    * I/O address (0x200); is this enabling of the Digital Enhanced Game Port???
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174)    * Or maybe this simply switches off the NE558 circuit, since enabling this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175)    * still lets us evaluate button states, but not axis states */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176)   #define IO_6A_SOMETHING2_GAMEPORT      0x0400
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) 	/* writing 0x0300: causes quite some crackling during
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) 	 * PC activity such as switching windows (PCI traffic??
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) 	 * --> FIFO/timing settings???) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) 	/* writing 0x0100 plus/or 0x0200 inhibits playback */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) 	/* since the Windows .INF file has Flag_Enable_JoyStick and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) 	 * Flag_Enable_SB_DOS_Emulation directly together, it stands to reason
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) 	 * that some other bit in this same register might be responsible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) 	 * for SB DOS Emulation activation (note that the file did NOT define
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) 	 * a switch for OPL3!) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) #define IDX_IO_6CH		0x6C	/* unknown; fully read-writable */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) #define IDX_IO_6EH		0x6E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) 	/* writing 0xffff returns 0x83fe (or 0x03fe only).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) 	 * writing 0x83 (and only 0x83!!) to 0x6f will cause 0x6c to switch
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) 	 * from 0000 to ffff. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) /* further I/O indices not saved/restored and not readable after writing,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193)  * so probably not used */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) /*** Gameport area port indices ***/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) /* (only 0x06 of 0x08 bytes saved/restored by Windows driver) */ 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) #define AZF_IO_SIZE_GAME		0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) #define AZF_IO_SIZE_GAME_PM		0x06
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) 	AZF_GAME_LEGACY_IO_PORT = 0x200
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) #define IDX_GAME_LEGACY_COMPATIBLE	0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) 	/* in some operation mode, writing anything to this port
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) 	 * triggers an interrupt:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) 	 * yup, that's in case IDX_GAME_01H has one of the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) 	 * axis measurement bits enabled
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) 	 * (and of course one needs to have GAME_HWCFG_IRQ_ENABLE, too) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) #define IDX_GAME_AXES_CONFIG            0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) 	/* NOTE: layout of this register awfully similar (read: "identical??")
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) 	 * to AD1815JS.pdf (p.29) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216)   /* enables axis 1 (X axis) measurement: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217)   #define GAME_AXES_ENABLE_1		0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218)   /* enables axis 2 (Y axis) measurement: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219)   #define GAME_AXES_ENABLE_2		0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220)   /* enables axis 3 (X axis) measurement: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221)   #define GAME_AXES_ENABLE_3		0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222)   /* enables axis 4 (Y axis) measurement: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223)   #define GAME_AXES_ENABLE_4		0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224)   /* selects the current axis to read the measured value of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225)    * (at IDX_GAME_AXIS_VALUE):
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226)    * 00 = axis 1, 01 = axis 2, 10 = axis 3, 11 = axis 4: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227)   #define GAME_AXES_READ_MASK		0x30
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228)   /* enable to have the latch continuously accept ADC values
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229)    * (and continuously cause interrupts in case interrupts are enabled);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230)    * AD1815JS.pdf says it's ~16ms interval there: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231)   #define GAME_AXES_LATCH_ENABLE	0x40
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232)   /* joystick data (measured axes) ready for reading: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233)   #define GAME_AXES_SAMPLING_READY	0x80
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235)   /* NOTE: other card specs (SiS960 and others!) state that the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236)    * game position latches should be frozen when reading and be freed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237)    * (== reset?) after reading!!!
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238)    * Freezing most likely means disabling 0x40 (GAME_AXES_LATCH_ENABLE),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239)    *  but how to free the value? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240)   /* An internet search for "gameport latch ADC" should provide some insight
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241)    * into how to program such a gameport system. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243)   /* writing 0xf0 to 01H once reset both counters to 0, in some special mode!?
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244)    * yup, in case 6AH 0x20 is not enabled
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245)    * (and 0x40 is sufficient, 0xf0 is not needed) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) #define IDX_GAME_AXIS_VALUE	0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) 	/* R: value of currently configured axis (word value!);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) 	 * W: trigger axis measurement */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) #define IDX_GAME_HWCONFIG	0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) 	/* note: bits 4 to 7 are never set (== 0) when reading!
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) 	 * --> reserved bits? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254)   /* enables IRQ notification upon axes measurement ready: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255)   #define GAME_HWCFG_IRQ_ENABLE			0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256)   /* these bits choose a different frequency for the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257)    *  internal ADC counter increment.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258)    * hmm, seems to be a combo of bits:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259)    * 00 --> standard frequency
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260)    * 10 --> 1/2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261)    * 01 --> 1/20
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262)    * 11 --> 1/200: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263)   #define GAME_HWCFG_ADC_COUNTER_FREQ_MASK	0x06
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265)   /* FIXME: these values might be reversed... */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266)   #define GAME_HWCFG_ADC_COUNTER_FREQ_STD	0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267)   #define GAME_HWCFG_ADC_COUNTER_FREQ_1_2	1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268)   #define GAME_HWCFG_ADC_COUNTER_FREQ_1_20	2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269)   #define GAME_HWCFG_ADC_COUNTER_FREQ_1_200	3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271)   /* enable gameport legacy I/O address (0x200)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272)    * I was unable to locate any configurability for a different address: */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273)   #define GAME_HWCFG_LEGACY_ADDRESS_ENABLE	0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) /*** MPU401 ***/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) #define AZF_IO_SIZE_MPU		0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) #define AZF_IO_SIZE_MPU_PM	0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) /*** OPL3 synth ***/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) /* (only 0x06 of 0x08 bytes saved/restored by Windows driver) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) #define AZF_IO_SIZE_OPL3	0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) #define AZF_IO_SIZE_OPL3_PM	0x06
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) /* hmm, given that a standard OPL3 has 4 registers only,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284)  * there might be some enhanced functionality lurking at the end
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285)  * (especially since register 0x04 has a "non-empty" value 0xfe) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) /*** mixer I/O area port indices ***/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) /* (only 0x22 of 0x40 bytes saved/restored by Windows driver)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289)  * UNFORTUNATELY azf3328 is NOT truly AC97 compliant: see main file intro */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) #define AZF_IO_SIZE_MIXER	0x40
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) #define AZF_IO_SIZE_MIXER_PM	0x22
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293)   #define MIXER_VOLUME_RIGHT_MASK	0x001f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294)   #define MIXER_VOLUME_LEFT_MASK	0x1f00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295)   #define MIXER_MUTE_MASK		0x8000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) #define IDX_MIXER_RESET		0x00 /* does NOT seem to have AC97 ID bits */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) #define IDX_MIXER_PLAY_MASTER   0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) #define IDX_MIXER_MODEMOUT      0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) #define IDX_MIXER_BASSTREBLE    0x06
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300)   #define MIXER_BASSTREBLE_TREBLE_VOLUME_MASK	0x000e
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301)   #define MIXER_BASSTREBLE_BASS_VOLUME_MASK	0x0e00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) #define IDX_MIXER_PCBEEP        0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) #define IDX_MIXER_MODEMIN       0x0a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) #define IDX_MIXER_MIC           0x0c
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305)   #define MIXER_MIC_MICGAIN_20DB_ENHANCEMENT_MASK	0x0040
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) #define IDX_MIXER_LINEIN        0x0e
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) #define IDX_MIXER_CDAUDIO       0x10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) #define IDX_MIXER_VIDEO         0x12
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) #define IDX_MIXER_AUX           0x14
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) #define IDX_MIXER_WAVEOUT       0x16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) #define IDX_MIXER_FMSYNTH       0x18
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) #define IDX_MIXER_REC_SELECT    0x1a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313)   #define MIXER_REC_SELECT_MIC		0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314)   #define MIXER_REC_SELECT_CD		0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315)   #define MIXER_REC_SELECT_VIDEO	0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316)   #define MIXER_REC_SELECT_AUX		0x03
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317)   #define MIXER_REC_SELECT_LINEIN	0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318)   #define MIXER_REC_SELECT_MIXSTEREO	0x05
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319)   #define MIXER_REC_SELECT_MIXMONO	0x06
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320)   #define MIXER_REC_SELECT_MONOIN	0x07
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) #define IDX_MIXER_REC_VOLUME    0x1c
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) #define IDX_MIXER_ADVCTL1       0x1e
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323)   /* unlisted bits are unmodifiable */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324)   #define MIXER_ADVCTL1_3DWIDTH_MASK	0x000e
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325)   #define MIXER_ADVCTL1_HIFI3D_MASK	0x0300 /* yup, this is missing the high bit that official AC97 contains, plus it doesn't have linear bit value range behaviour but instead acts weirdly (possibly we're dealing with two *different* 3D settings here??) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) #define IDX_MIXER_ADVCTL2       0x20 /* subset of AC97_GENERAL_PURPOSE reg! */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327)   /* unlisted bits are unmodifiable */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328)   #define MIXER_ADVCTL2_LPBK		0x0080 /* Loopback mode -- Win driver: "WaveOut3DBypass"? mutes WaveOut at LineOut */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329)   #define MIXER_ADVCTL2_MS		0x0100 /* Mic Select 0=Mic1, 1=Mic2 -- Win driver: "ModemOutSelect"?? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330)   #define MIXER_ADVCTL2_MIX		0x0200 /* Mono output select 0=Mix, 1=Mic; Win driver: "MonoSelectSource"?? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331)   #define MIXER_ADVCTL2_3D		0x2000 /* 3D Enhancement 1=on */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332)   #define MIXER_ADVCTL2_POP		0x8000 /* Pcm Out Path, 0=pre 3D, 1=post 3D */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333)   
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) #define IDX_MIXER_SOMETHING30H	0x30 /* used, but unknown??? */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) /* driver internal flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) #define SET_CHAN_LEFT	1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) #define SET_CHAN_RIGHT	2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) /* helper macro to align I/O port ranges to 32bit I/O width */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) #define AZF_ALIGN(x) (((x) + 3) & (~3))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) #endif /* __SOUND_AZT3328_H  */