Quelle  fsl_ssi.h   Sprache: C

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * fsl_ssi.h - ALSA SSI interface for the Freescale MPC8610 and i.MX SoC
 *
 * Author: Timur Tabi <timur@freescale.com>
 *
 * Copyright 2007-2008 Freescale Semiconductor, Inc.
 */

#ifndef _MPC8610_I2S_H
#define _MPC8610_I2S_H

/* -- SSI Register Map -- */

/* SSI Transmit Data Register 0 */
#define REG_SSI_STX0   0x00
/* SSI Transmit Data Register 1 */
#define REG_SSI_STX1   0x04
/* SSI Receive Data Register 0 */
#define REG_SSI_SRX0   0x08
/* SSI Receive Data Register 1 */
#define REG_SSI_SRX1   0x0c
/* SSI Control Register */
#define REG_SSI_SCR   0x10
/* SSI Interrupt Status Register */
#define REG_SSI_SISR   0x14
/* SSI Interrupt Enable Register */
#define REG_SSI_SIER   0x18
/* SSI Transmit Configuration Register */
#define REG_SSI_STCR   0x1c
/* SSI Receive Configuration Register */
#define REG_SSI_SRCR   0x20
#define REG_SSI_SxCR(tx)  ((tx) ? REG_SSI_STCR : REG_SSI_SRCR)
/* SSI Transmit Clock Control Register */
#define REG_SSI_STCCR   0x24
/* SSI Receive Clock Control Register */
#define REG_SSI_SRCCR   0x28
#define REG_SSI_SxCCR(tx)  ((tx) ? REG_SSI_STCCR : REG_SSI_SRCCR)
/* SSI FIFO Control/Status Register */
#define REG_SSI_SFCSR   0x2c
/*
 * SSI Test Register (Intended for debugging purposes only)
 *
 * Note: STR is not documented in recent IMX datasheet, but
 * is described in IMX51 reference manual at section 56.3.3.14
 */
#define REG_SSI_STR   0x30
/*
 * SSI Option Register (Intended for internal use only)
 *
 * Note: SOR is not documented in recent IMX datasheet, but
 * is described in IMX51 reference manual at section 56.3.3.15
 */
#define REG_SSI_SOR   0x34
/* SSI AC97 Control Register */
#define REG_SSI_SACNT   0x38
/* SSI AC97 Command Address Register */
#define REG_SSI_SACADD   0x3c
/* SSI AC97 Command Data Register */
#define REG_SSI_SACDAT   0x40
/* SSI AC97 Tag Register */
#define REG_SSI_SATAG   0x44
/* SSI Transmit Time Slot Mask Register */
#define REG_SSI_STMSK   0x48
/* SSI  Receive Time Slot Mask Register */
#define REG_SSI_SRMSK   0x4c
#define REG_SSI_SxMSK(tx)  ((tx) ? REG_SSI_STMSK : REG_SSI_SRMSK)
/*
 * SSI AC97 Channel Status Register
 *
 * The status could be changed by:
 * 1) Writing a '1' bit at some position in SACCEN sets relevant bit in SACCST
 * 2) Writing a '1' bit at some position in SACCDIS unsets the relevant bit
 * 3) Receivng a '1' in SLOTREQ bit from external CODEC via AC Link
 */
#define REG_SSI_SACCST   0x50
/* SSI AC97 Channel Enable Register -- Set bits in SACCST */
#define REG_SSI_SACCEN   0x54
/* SSI AC97 Channel Disable Register -- Clear bits in SACCST */
#define REG_SSI_SACCDIS   0x58

/* -- SSI Register Field Maps -- */

/* SSI Control Register -- REG_SSI_SCR 0x10 */
#define SSI_SCR_SYNC_TX_FS  0x00001000
#define SSI_SCR_RFR_CLK_DIS  0x00000800
#define SSI_SCR_TFR_CLK_DIS  0x00000400
#define SSI_SCR_TCH_EN   0x00000100
#define SSI_SCR_SYS_CLK_EN  0x00000080
#define SSI_SCR_I2S_MODE_MASK  0x00000060
#define SSI_SCR_I2S_MODE_NORMAL  0x00000000
#define SSI_SCR_I2S_MODE_MASTER  0x00000020
#define SSI_SCR_I2S_MODE_SLAVE  0x00000040
#define SSI_SCR_SYN   0x00000010
#define SSI_SCR_NET   0x00000008
#define SSI_SCR_I2S_NET_MASK  (SSI_SCR_NET | SSI_SCR_I2S_MODE_MASK)
#define SSI_SCR_RE   0x00000004
#define SSI_SCR_TE   0x00000002
#define SSI_SCR_SSIEN   0x00000001

/* SSI Interrupt Status Register -- REG_SSI_SISR 0x14 */
#define SSI_SISR_RFRC   0x01000000
#define SSI_SISR_TFRC   0x00800000
#define SSI_SISR_CMDAU   0x00040000
#define SSI_SISR_CMDDU   0x00020000
#define SSI_SISR_RXT   0x00010000
#define SSI_SISR_RDR1   0x00008000
#define SSI_SISR_RDR0   0x00004000
#define SSI_SISR_TDE1   0x00002000
#define SSI_SISR_TDE0   0x00001000
#define SSI_SISR_ROE1   0x00000800
#define SSI_SISR_ROE0   0x00000400
#define SSI_SISR_TUE1   0x00000200
#define SSI_SISR_TUE0   0x00000100
#define SSI_SISR_TFS   0x00000080
#define SSI_SISR_RFS   0x00000040
#define SSI_SISR_TLS   0x00000020
#define SSI_SISR_RLS   0x00000010
#define SSI_SISR_RFF1   0x00000008
#define SSI_SISR_RFF0   0x00000004
#define SSI_SISR_TFE1   0x00000002
#define SSI_SISR_TFE0   0x00000001

/* SSI Interrupt Enable Register -- REG_SSI_SIER 0x18 */
#define SSI_SIER_RFRC_EN  0x01000000
#define SSI_SIER_TFRC_EN  0x00800000
#define SSI_SIER_RDMAE   0x00400000
#define SSI_SIER_RIE   0x00200000
#define SSI_SIER_TDMAE   0x00100000
#define SSI_SIER_TIE   0x00080000
#define SSI_SIER_CMDAU_EN  0x00040000
#define SSI_SIER_CMDDU_EN  0x00020000
#define SSI_SIER_RXT_EN   0x00010000
#define SSI_SIER_RDR1_EN  0x00008000
#define SSI_SIER_RDR0_EN  0x00004000
#define SSI_SIER_TDE1_EN  0x00002000
#define SSI_SIER_TDE0_EN  0x00001000
#define SSI_SIER_ROE1_EN  0x00000800
#define SSI_SIER_ROE0_EN  0x00000400
#define SSI_SIER_TUE1_EN  0x00000200
#define SSI_SIER_TUE0_EN  0x00000100
#define SSI_SIER_TFS_EN   0x00000080
#define SSI_SIER_RFS_EN   0x00000040
#define SSI_SIER_TLS_EN   0x00000020
#define SSI_SIER_RLS_EN   0x00000010
#define SSI_SIER_RFF1_EN  0x00000008
#define SSI_SIER_RFF0_EN  0x00000004
#define SSI_SIER_TFE1_EN  0x00000002
#define SSI_SIER_TFE0_EN  0x00000001

/* SSI Transmit Configuration Register -- REG_SSI_STCR 0x1C */
#define SSI_STCR_TXBIT0   0x00000200
#define SSI_STCR_TFEN1   0x00000100
#define SSI_STCR_TFEN0   0x00000080
#define SSI_STCR_TFDIR   0x00000040
#define SSI_STCR_TXDIR   0x00000020
#define SSI_STCR_TSHFD   0x00000010
#define SSI_STCR_TSCKP   0x00000008
#define SSI_STCR_TFSI   0x00000004
#define SSI_STCR_TFSL   0x00000002
#define SSI_STCR_TEFS   0x00000001

/* SSI Receive Configuration Register -- REG_SSI_SRCR 0x20 */
#define SSI_SRCR_RXEXT   0x00000400
#define SSI_SRCR_RXBIT0   0x00000200
#define SSI_SRCR_RFEN1   0x00000100
#define SSI_SRCR_RFEN0   0x00000080
#define SSI_SRCR_RFDIR   0x00000040
#define SSI_SRCR_RXDIR   0x00000020
#define SSI_SRCR_RSHFD   0x00000010
#define SSI_SRCR_RSCKP   0x00000008
#define SSI_SRCR_RFSI   0x00000004
#define SSI_SRCR_RFSL   0x00000002
#define SSI_SRCR_REFS   0x00000001

/*
 * SSI Transmit Clock Control Register -- REG_SSI_STCCR 0x24
 * SSI Receive Clock Control Register -- REG_SSI_SRCCR 0x28
 */
#define SSI_SxCCR_DIV2_SHIFT  18
#define SSI_SxCCR_DIV2   0x00040000
#define SSI_SxCCR_PSR_SHIFT  17
#define SSI_SxCCR_PSR   0x00020000
#define SSI_SxCCR_WL_SHIFT  13
#define SSI_SxCCR_WL_MASK  0x0001E000
#define SSI_SxCCR_WL(x) \
 (((((x) / 2) - 1) << SSI_SxCCR_WL_SHIFT) & SSI_SxCCR_WL_MASK)
#define SSI_SxCCR_DC_SHIFT  8
#define SSI_SxCCR_DC_MASK  0x00001F00
#define SSI_SxCCR_DC(x) \
 ((((x) - 1) << SSI_SxCCR_DC_SHIFT) & SSI_SxCCR_DC_MASK)
#define SSI_SxCCR_PM_SHIFT  0
#define SSI_SxCCR_PM_MASK  0x000000FF
#define SSI_SxCCR_PM(x) \
 ((((x) - 1) << SSI_SxCCR_PM_SHIFT) & SSI_SxCCR_PM_MASK)

/*
 * SSI FIFO Control/Status Register -- REG_SSI_SFCSR 0x2c
 *
 * Tx or Rx FIFO Counter -- SSI_SFCSR_xFCNTy Read-Only
 * Tx or Rx FIFO Watermarks -- SSI_SFCSR_xFWMy Read/Write
 */
#define SSI_SFCSR_RFCNT1_SHIFT  28
#define SSI_SFCSR_RFCNT1_MASK  0xF0000000
#define SSI_SFCSR_RFCNT1(x) \
 (((x) & SSI_SFCSR_RFCNT1_MASK) >> SSI_SFCSR_RFCNT1_SHIFT)
#define SSI_SFCSR_TFCNT1_SHIFT  24
#define SSI_SFCSR_TFCNT1_MASK  0x0F000000
#define SSI_SFCSR_TFCNT1(x) \
 (((x) & SSI_SFCSR_TFCNT1_MASK) >> SSI_SFCSR_TFCNT1_SHIFT)
#define SSI_SFCSR_RFWM1_SHIFT  20
#define SSI_SFCSR_RFWM1_MASK  0x00F00000
#define SSI_SFCSR_RFWM1(x) \
 (((x) << SSI_SFCSR_RFWM1_SHIFT) & SSI_SFCSR_RFWM1_MASK)
#define SSI_SFCSR_TFWM1_SHIFT  16
#define SSI_SFCSR_TFWM1_MASK  0x000F0000
#define SSI_SFCSR_TFWM1(x) \
 (((x) << SSI_SFCSR_TFWM1_SHIFT) & SSI_SFCSR_TFWM1_MASK)
#define SSI_SFCSR_RFCNT0_SHIFT  12
#define SSI_SFCSR_RFCNT0_MASK  0x0000F000
#define SSI_SFCSR_RFCNT0(x) \
 (((x) & SSI_SFCSR_RFCNT0_MASK) >> SSI_SFCSR_RFCNT0_SHIFT)
#define SSI_SFCSR_TFCNT0_SHIFT  8
#define SSI_SFCSR_TFCNT0_MASK  0x00000F00
#define SSI_SFCSR_TFCNT0(x) \
 (((x) & SSI_SFCSR_TFCNT0_MASK) >> SSI_SFCSR_TFCNT0_SHIFT)
#define SSI_SFCSR_RFWM0_SHIFT  4
#define SSI_SFCSR_RFWM0_MASK  0x000000F0
#define SSI_SFCSR_RFWM0(x) \
 (((x) << SSI_SFCSR_RFWM0_SHIFT) & SSI_SFCSR_RFWM0_MASK)
#define SSI_SFCSR_TFWM0_SHIFT  0
#define SSI_SFCSR_TFWM0_MASK  0x0000000F
#define SSI_SFCSR_TFWM0(x) \
 (((x) << SSI_SFCSR_TFWM0_SHIFT) & SSI_SFCSR_TFWM0_MASK)

/* SSI Test Register -- REG_SSI_STR 0x30 */
#define SSI_STR_TEST   0x00008000
#define SSI_STR_RCK2TCK   0x00004000
#define SSI_STR_RFS2TFS   0x00002000
#define SSI_STR_RXSTATE(x)  (((x) >> 8) & 0x1F)
#define SSI_STR_TXD2RXD   0x00000080
#define SSI_STR_TCK2RCK   0x00000040
#define SSI_STR_TFS2RFS   0x00000020
#define SSI_STR_TXSTATE(x)  ((x) & 0x1F)

/* SSI Option Register -- REG_SSI_SOR 0x34 */
#define SSI_SOR_CLKOFF   0x00000040
#define SSI_SOR_RX_CLR   0x00000020
#define SSI_SOR_TX_CLR   0x00000010
#define SSI_SOR_xX_CLR(tx)  ((tx) ? SSI_SOR_TX_CLR : SSI_SOR_RX_CLR)
#define SSI_SOR_INIT   0x00000008
#define SSI_SOR_WAIT_SHIFT  1
#define SSI_SOR_WAIT_MASK  0x00000006
#define SSI_SOR_WAIT(x)   (((x) & 3) << SSI_SOR_WAIT_SHIFT)
#define SSI_SOR_SYNRST   0x00000001

/* SSI AC97 Control Register -- REG_SSI_SACNT 0x38 */
#define SSI_SACNT_FRDIV(x)  (((x) & 0x3f) << 5)
#define SSI_SACNT_WR   0x00000010
#define SSI_SACNT_RD   0x00000008
#define SSI_SACNT_RDWR_MASK  0x00000018
#define SSI_SACNT_TIF   0x00000004
#define SSI_SACNT_FV   0x00000002
#define SSI_SACNT_AC97EN  0x00000001


struct device;

#if IS_ENABLED(CONFIG_DEBUG_FS)

struct fsl_ssi_dbg {
 struct dentry *dbg_dir;

 struct {
  unsigned int rfrc;
  unsigned int tfrc;
  unsigned int cmdau;
  unsigned int cmddu;
  unsigned int rxt;
  unsigned int rdr1;
  unsigned int rdr0;
  unsigned int tde1;
  unsigned int tde0;
  unsigned int roe1;
  unsigned int roe0;
  unsigned int tue1;
  unsigned int tue0;
  unsigned int tfs;
  unsigned int rfs;
  unsigned int tls;
  unsigned int rls;
  unsigned int rff1;
  unsigned int rff0;
  unsigned int tfe1;
  unsigned int tfe0;
 } stats;
};

void fsl_ssi_dbg_isr(struct fsl_ssi_dbg *ssi_dbg, u32 sisr);

void fsl_ssi_debugfs_create(struct fsl_ssi_dbg *ssi_dbg, struct device *dev);

void fsl_ssi_debugfs_remove(struct fsl_ssi_dbg *ssi_dbg);

#else

struct fsl_ssi_dbg {
};

static inline void fsl_ssi_dbg_isr(struct fsl_ssi_dbg *stats, u32 sisr)
{
}

static inline void fsl_ssi_debugfs_create(struct fsl_ssi_dbg *ssi_dbg,
       struct device *dev)
{
}

static inline void fsl_ssi_debugfs_remove(struct fsl_ssi_dbg *ssi_dbg)
{
}
#endif  /* ! IS_ENABLED(CONFIG_DEBUG_FS) */

#endif