include/soc/fsl/qe/qe.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Copyright (C) 2006 Freescale Semiconductor, Inc. All rights reserved.
   4  *
   5  * Authors:     Shlomi Gridish <gridish@freescale.com>
   6  *              Li Yang <leoli@freescale.com>
   7  *
   8  * Description:
   9  * QUICC Engine (QE) external definitions and structure.
  10  */
  11 #ifndef _ASM_POWERPC_QE_H
  12 #define _ASM_POWERPC_QE_H
  13 #ifdef __KERNEL__
  14
  15 #include <linux/compiler.h>
  16 #include <linux/genalloc.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/errno.h>
  19 #include <linux/err.h>
  20 #include <soc/fsl/cpm.h>
  21 #include <soc/fsl/qe/immap_qe.h>
  22 #include <linux/of.h>
  23 #include <linux/of_address.h>
  24 #include <linux/types.h>
  25
  26 #define QE_NUM_OF_SNUM  256     /* There are 256 serial number in QE */
  27 #define QE_NUM_OF_BRGS  16
  28 #define QE_NUM_OF_PORTS 1024
  29
  30 /* Memory partitions
  31 */
  32 #define MEM_PART_SYSTEM         0
  33 #define MEM_PART_SECONDARY      1
  34 #define MEM_PART_MURAM          2
  35
  36 /* Clocks and BRGs */
  37 enum qe_clock {
  38         QE_CLK_NONE = 0,
  39         QE_BRG1,                /* Baud Rate Generator 1 */
  40         QE_BRG2,                /* Baud Rate Generator 2 */
  41         QE_BRG3,                /* Baud Rate Generator 3 */
  42         QE_BRG4,                /* Baud Rate Generator 4 */
  43         QE_BRG5,                /* Baud Rate Generator 5 */
  44         QE_BRG6,                /* Baud Rate Generator 6 */
  45         QE_BRG7,                /* Baud Rate Generator 7 */
  46         QE_BRG8,                /* Baud Rate Generator 8 */
  47         QE_BRG9,                /* Baud Rate Generator 9 */
  48         QE_BRG10,               /* Baud Rate Generator 10 */
  49         QE_BRG11,               /* Baud Rate Generator 11 */
  50         QE_BRG12,               /* Baud Rate Generator 12 */
  51         QE_BRG13,               /* Baud Rate Generator 13 */
  52         QE_BRG14,               /* Baud Rate Generator 14 */
  53         QE_BRG15,               /* Baud Rate Generator 15 */
  54         QE_BRG16,               /* Baud Rate Generator 16 */
  55         QE_CLK1,                /* Clock 1 */
  56         QE_CLK2,                /* Clock 2 */
  57         QE_CLK3,                /* Clock 3 */
  58         QE_CLK4,                /* Clock 4 */
  59         QE_CLK5,                /* Clock 5 */
  60         QE_CLK6,                /* Clock 6 */
  61         QE_CLK7,                /* Clock 7 */
  62         QE_CLK8,                /* Clock 8 */
  63         QE_CLK9,                /* Clock 9 */
  64         QE_CLK10,               /* Clock 10 */
  65         QE_CLK11,               /* Clock 11 */
  66         QE_CLK12,               /* Clock 12 */
  67         QE_CLK13,               /* Clock 13 */
  68         QE_CLK14,               /* Clock 14 */
  69         QE_CLK15,               /* Clock 15 */
  70         QE_CLK16,               /* Clock 16 */
  71         QE_CLK17,               /* Clock 17 */
  72         QE_CLK18,               /* Clock 18 */
  73         QE_CLK19,               /* Clock 19 */
  74         QE_CLK20,               /* Clock 20 */
  75         QE_CLK21,               /* Clock 21 */
  76         QE_CLK22,               /* Clock 22 */
  77         QE_CLK23,               /* Clock 23 */
  78         QE_CLK24,               /* Clock 24 */
  79         QE_RSYNC_PIN,           /* RSYNC from pin */
  80         QE_TSYNC_PIN,           /* TSYNC from pin */
  81         QE_CLK_DUMMY
  82 };
  83
  84 static inline bool qe_clock_is_brg(enum qe_clock clk)
  85 {
  86         return clk >= QE_BRG1 && clk <= QE_BRG16;
  87 }
  88
  89 extern spinlock_t cmxgcr_lock;
  90
  91 /* Export QE common operations */
  92 #ifdef CONFIG_QUICC_ENGINE
  93 extern void qe_reset(void);
  94 #else
  95 static inline void qe_reset(void) {}
  96 #endif
  97
  98 int cpm_muram_init(void);
  99
 100 #if defined(CONFIG_CPM) || defined(CONFIG_QUICC_ENGINE)
 101 s32 cpm_muram_alloc(unsigned long size, unsigned long align);
 102 int cpm_muram_free(s32 offset);
 103 s32 cpm_muram_alloc_fixed(unsigned long offset, unsigned long size);
 104 void __iomem *cpm_muram_addr(unsigned long offset);
 105 unsigned long cpm_muram_offset(void __iomem *addr);
 106 dma_addr_t cpm_muram_dma(void __iomem *addr);
 107 #else
 108 static inline s32 cpm_muram_alloc(unsigned long size,
 109                                   unsigned long align)
 110 {
 111         return -ENOSYS;
 112 }
 113
 114 static inline int cpm_muram_free(s32 offset)
 115 {
 116         return -ENOSYS;
 117 }
 118
 119 static inline s32 cpm_muram_alloc_fixed(unsigned long offset,
 120                                         unsigned long size)
 121 {
 122         return -ENOSYS;
 123 }
 124
 125 static inline void __iomem *cpm_muram_addr(unsigned long offset)
 126 {
 127         return NULL;
 128 }
 129
 130 static inline unsigned long cpm_muram_offset(void __iomem *addr)
 131 {
 132         return -ENOSYS;
 133 }
 134
 135 static inline dma_addr_t cpm_muram_dma(void __iomem *addr)
 136 {
 137         return 0;
 138 }
 139 #endif /* defined(CONFIG_CPM) || defined(CONFIG_QUICC_ENGINE) */
 140
 141 /* QE PIO */
 142 #define QE_PIO_PINS 32
 143
 144 struct qe_pio_regs {
 145         __be32  cpodr;          /* Open drain register */
 146         __be32  cpdata;         /* Data register */
 147         __be32  cpdir1;         /* Direction register */
 148         __be32  cpdir2;         /* Direction register */
 149         __be32  cppar1;         /* Pin assignment register */
 150         __be32  cppar2;         /* Pin assignment register */
 151 #ifdef CONFIG_PPC_85xx
 152         u8      pad[8];
 153 #endif
 154 };
 155
 156 #define QE_PIO_DIR_IN   2
 157 #define QE_PIO_DIR_OUT  1
 158 extern void __par_io_config_pin(struct qe_pio_regs __iomem *par_io, u8 pin,
 159                                 int dir, int open_drain, int assignment,
 160                                 int has_irq);
 161 #ifdef CONFIG_QUICC_ENGINE
 162 extern int par_io_init(struct device_node *np);
 163 extern int par_io_of_config(struct device_node *np);
 164 extern int par_io_config_pin(u8 port, u8 pin, int dir, int open_drain,
 165                              int assignment, int has_irq);
 166 extern int par_io_data_set(u8 port, u8 pin, u8 val);
 167 #else
 168 static inline int par_io_init(struct device_node *np) { return -ENOSYS; }
 169 static inline int par_io_of_config(struct device_node *np) { return -ENOSYS; }
 170 static inline int par_io_config_pin(u8 port, u8 pin, int dir, int open_drain,
 171                 int assignment, int has_irq) { return -ENOSYS; }
 172 static inline int par_io_data_set(u8 port, u8 pin, u8 val) { return -ENOSYS; }
 173 #endif /* CONFIG_QUICC_ENGINE */
 174
 175 /*
 176  * Pin multiplexing functions.
 177  */
 178 struct qe_pin;
 179 #ifdef CONFIG_QE_GPIO
 180 extern struct qe_pin *qe_pin_request(struct device_node *np, int index);
 181 extern void qe_pin_free(struct qe_pin *qe_pin);
 182 extern void qe_pin_set_gpio(struct qe_pin *qe_pin);
 183 extern void qe_pin_set_dedicated(struct qe_pin *pin);
 184 #else
 185 static inline struct qe_pin *qe_pin_request(struct device_node *np, int index)
 186 {
 187         return ERR_PTR(-ENOSYS);
 188 }
 189 static inline void qe_pin_free(struct qe_pin *qe_pin) {}
 190 static inline void qe_pin_set_gpio(struct qe_pin *qe_pin) {}
 191 static inline void qe_pin_set_dedicated(struct qe_pin *pin) {}
 192 #endif /* CONFIG_QE_GPIO */
 193
 194 #ifdef CONFIG_QUICC_ENGINE
 195 int qe_issue_cmd(u32 cmd, u32 device, u8 mcn_protocol, u32 cmd_input);
 196 #else
 197 static inline int qe_issue_cmd(u32 cmd, u32 device, u8 mcn_protocol,
 198                                u32 cmd_input)
 199 {
 200         return -ENOSYS;
 201 }
 202 #endif /* CONFIG_QUICC_ENGINE */
 203
 204 /* QE internal API */
 205 enum qe_clock qe_clock_source(const char *source);
 206 unsigned int qe_get_brg_clk(void);
 207 int qe_setbrg(enum qe_clock brg, unsigned int rate, unsigned int multiplier);
 208 int qe_get_snum(void);
 209 void qe_put_snum(u8 snum);
 210 unsigned int qe_get_num_of_risc(void);
 211 unsigned int qe_get_num_of_snums(void);
 212
 213 static inline int qe_alive_during_sleep(void)
 214 {
 215         /*
 216          * MPC8568E reference manual says:
 217          *
 218          * "...power down sequence waits for all I/O interfaces to become idle.
 219          *  In some applications this may happen eventually without actively
 220          *  shutting down interfaces, but most likely, software will have to
 221          *  take steps to shut down the eTSEC, QUICC Engine Block, and PCI
 222          *  interfaces before issuing the command (either the write to the core
 223          *  MSR[WE] as described above or writing to POWMGTCSR) to put the
 224          *  device into sleep state."
 225          *
 226          * MPC8569E reference manual has a similar paragraph.
 227          */
 228 #ifdef CONFIG_PPC_85xx
 229         return 0;
 230 #else
 231         return 1;
 232 #endif
 233 }
 234
 235 /* we actually use cpm_muram implementation, define this for convenience */
 236 #define qe_muram_init cpm_muram_init
 237 #define qe_muram_alloc cpm_muram_alloc
 238 #define qe_muram_alloc_fixed cpm_muram_alloc_fixed
 239 #define qe_muram_free cpm_muram_free
 240 #define qe_muram_addr cpm_muram_addr
 241 #define qe_muram_offset cpm_muram_offset
 242 #define qe_muram_dma cpm_muram_dma
 243
 244 #ifdef CONFIG_PPC32
 245 #define qe_iowrite8(val, addr)     out_8(addr, val)
 246 #define qe_iowrite16be(val, addr)  out_be16(addr, val)
 247 #define qe_iowrite32be(val, addr)  out_be32(addr, val)
 248 #define qe_ioread8(addr)           in_8(addr)
 249 #define qe_ioread16be(addr)        in_be16(addr)
 250 #define qe_ioread32be(addr)        in_be32(addr)
 251 #else
 252 #define qe_iowrite8(val, addr)     iowrite8(val, addr)
 253 #define qe_iowrite16be(val, addr)  iowrite16be(val, addr)
 254 #define qe_iowrite32be(val, addr)  iowrite32be(val, addr)
 255 #define qe_ioread8(addr)           ioread8(addr)
 256 #define qe_ioread16be(addr)        ioread16be(addr)
 257 #define qe_ioread32be(addr)        ioread32be(addr)
 258 #endif
 259
 260 #define qe_setbits_be32(_addr, _v) qe_iowrite32be(qe_ioread32be(_addr) |  (_v), (_addr))
 261 #define qe_clrbits_be32(_addr, _v) qe_iowrite32be(qe_ioread32be(_addr) & ~(_v), (_addr))
 262
 263 #define qe_setbits_be16(_addr, _v) qe_iowrite16be(qe_ioread16be(_addr) |  (_v), (_addr))
 264 #define qe_clrbits_be16(_addr, _v) qe_iowrite16be(qe_ioread16be(_addr) & ~(_v), (_addr))
 265
 266 #define qe_setbits_8(_addr, _v) qe_iowrite8(qe_ioread8(_addr) |  (_v), (_addr))
 267 #define qe_clrbits_8(_addr, _v) qe_iowrite8(qe_ioread8(_addr) & ~(_v), (_addr))
 268
 269 #define qe_clrsetbits_be32(addr, clear, set) \
 270         qe_iowrite32be((qe_ioread32be(addr) & ~(clear)) | (set), (addr))
 271 #define qe_clrsetbits_be16(addr, clear, set) \
 272         qe_iowrite16be((qe_ioread16be(addr) & ~(clear)) | (set), (addr))
 273 #define qe_clrsetbits_8(addr, clear, set) \
 274         qe_iowrite8((qe_ioread8(addr) & ~(clear)) | (set), (addr))
 275
 276 /* Structure that defines QE firmware binary files.
 277  *
 278  * See Documentation/powerpc/qe_firmware.rst for a description of these
 279  * fields.
 280  */
 281 struct qe_firmware {
 282         struct qe_header {
 283                 __be32 length;  /* Length of the entire structure, in bytes */
 284                 u8 magic[3];    /* Set to { 'Q', 'E', 'F' } */
 285                 u8 version;     /* Version of this layout. First ver is '1' */
 286         } header;
 287         u8 id[62];      /* Null-terminated identifier string */
 288         u8 split;       /* 0 = shared I-RAM, 1 = split I-RAM */
 289         u8 count;       /* Number of microcode[] structures */
 290         struct {
 291                 __be16 model;           /* The SOC model  */
 292                 u8 major;               /* The SOC revision major */
 293                 u8 minor;               /* The SOC revision minor */
 294         } __attribute__ ((packed)) soc;
 295         u8 padding[4];                  /* Reserved, for alignment */
 296         __be64 extended_modes;          /* Extended modes */
 297         __be32 vtraps[8];               /* Virtual trap addresses */
 298         u8 reserved[4];                 /* Reserved, for future expansion */
 299         struct qe_microcode {
 300                 u8 id[32];              /* Null-terminated identifier */
 301                 __be32 traps[16];       /* Trap addresses, 0 == ignore */
 302                 __be32 eccr;            /* The value for the ECCR register */
 303                 __be32 iram_offset;     /* Offset into I-RAM for the code */
 304                 __be32 count;           /* Number of 32-bit words of the code */
 305                 __be32 code_offset;     /* Offset of the actual microcode */
 306                 u8 major;               /* The microcode version major */
 307                 u8 minor;               /* The microcode version minor */
 308                 u8 revision;            /* The microcode version revision */
 309                 u8 padding;             /* Reserved, for alignment */
 310                 u8 reserved[4];         /* Reserved, for future expansion */
 311         } __attribute__ ((packed)) microcode[1];
 312         /* All microcode binaries should be located here */
 313         /* CRC32 should be located here, after the microcode binaries */
 314 } __attribute__ ((packed));
 315
 316 struct qe_firmware_info {
 317         char id[64];            /* Firmware name */
 318         u32 vtraps[8];          /* Virtual trap addresses */
 319         u64 extended_modes;     /* Extended modes */
 320 };
 321
 322 #ifdef CONFIG_QUICC_ENGINE
 323 /* Upload a firmware to the QE */
 324 int qe_upload_firmware(const struct qe_firmware *firmware);
 325 #else
 326 static inline int qe_upload_firmware(const struct qe_firmware *firmware)
 327 {
 328         return -ENOSYS;
 329 }
 330 #endif /* CONFIG_QUICC_ENGINE */
 331
 332 /* Obtain information on the uploaded firmware */
 333 struct qe_firmware_info *qe_get_firmware_info(void);
 334
 335 /* QE USB */
 336 int qe_usb_clock_set(enum qe_clock clk, int rate);
 337
 338 /* Buffer descriptors */
 339 struct qe_bd {
 340         __be16 status;
 341         __be16 length;
 342         __be32 buf;
 343 } __attribute__ ((packed));
 344
 345 #define BD_STATUS_MASK  0xffff0000
 346 #define BD_LENGTH_MASK  0x0000ffff
 347
 348 /* Alignment */
 349 #define QE_INTR_TABLE_ALIGN     16      /* ??? */
 350 #define QE_ALIGNMENT_OF_BD      8
 351 #define QE_ALIGNMENT_OF_PRAM    64
 352
 353 /* RISC allocation */
 354 #define QE_RISC_ALLOCATION_RISC1        0x1  /* RISC 1 */
 355 #define QE_RISC_ALLOCATION_RISC2        0x2  /* RISC 2 */
 356 #define QE_RISC_ALLOCATION_RISC3        0x4  /* RISC 3 */
 357 #define QE_RISC_ALLOCATION_RISC4        0x8  /* RISC 4 */
 358 #define QE_RISC_ALLOCATION_RISC1_AND_RISC2      (QE_RISC_ALLOCATION_RISC1 | \
 359                                                  QE_RISC_ALLOCATION_RISC2)
 360 #define QE_RISC_ALLOCATION_FOUR_RISCS   (QE_RISC_ALLOCATION_RISC1 | \
 361                                          QE_RISC_ALLOCATION_RISC2 | \
 362                                          QE_RISC_ALLOCATION_RISC3 | \
 363                                          QE_RISC_ALLOCATION_RISC4)
 364
 365 /* QE extended filtering Table Lookup Key Size */
 366 enum qe_fltr_tbl_lookup_key_size {
 367         QE_FLTR_TABLE_LOOKUP_KEY_SIZE_8_BYTES
 368                 = 0x3f,         /* LookupKey parsed by the Generate LookupKey
 369                                    CMD is truncated to 8 bytes */
 370         QE_FLTR_TABLE_LOOKUP_KEY_SIZE_16_BYTES
 371                 = 0x5f,         /* LookupKey parsed by the Generate LookupKey
 372                                    CMD is truncated to 16 bytes */
 373 };
 374
 375 /* QE FLTR extended filtering Largest External Table Lookup Key Size */
 376 enum qe_fltr_largest_external_tbl_lookup_key_size {
 377         QE_FLTR_LARGEST_EXTERNAL_TABLE_LOOKUP_KEY_SIZE_NONE
 378                 = 0x0,/* not used */
 379         QE_FLTR_LARGEST_EXTERNAL_TABLE_LOOKUP_KEY_SIZE_8_BYTES
 380                 = QE_FLTR_TABLE_LOOKUP_KEY_SIZE_8_BYTES,        /* 8 bytes */
 381         QE_FLTR_LARGEST_EXTERNAL_TABLE_LOOKUP_KEY_SIZE_16_BYTES
 382                 = QE_FLTR_TABLE_LOOKUP_KEY_SIZE_16_BYTES,       /* 16 bytes */
 383 };
 384
 385 /* structure representing QE parameter RAM */
 386 struct qe_timer_tables {
 387         u16 tm_base;            /* QE timer table base adr */
 388         u16 tm_ptr;             /* QE timer table pointer */
 389         u16 r_tmr;              /* QE timer mode register */
 390         u16 r_tmv;              /* QE timer valid register */
 391         u32 tm_cmd;             /* QE timer cmd register */
 392         u32 tm_cnt;             /* QE timer internal cnt */
 393 } __attribute__ ((packed));
 394
 395 #define QE_FLTR_TAD_SIZE        8
 396
 397 /* QE extended filtering Termination Action Descriptor (TAD) */
 398 struct qe_fltr_tad {
 399         u8 serialized[QE_FLTR_TAD_SIZE];
 400 } __attribute__ ((packed));
 401
 402 /* Communication Direction */
 403 enum comm_dir {
 404         COMM_DIR_NONE = 0,
 405         COMM_DIR_RX = 1,
 406         COMM_DIR_TX = 2,
 407         COMM_DIR_RX_AND_TX = 3
 408 };
 409
 410 /* QE CMXUCR Registers.
 411  * There are two UCCs represented in each of the four CMXUCR registers.
 412  * These values are for the UCC in the LSBs
 413  */
 414 #define QE_CMXUCR_MII_ENET_MNG          0x00007000
 415 #define QE_CMXUCR_MII_ENET_MNG_SHIFT    12
 416 #define QE_CMXUCR_GRANT                 0x00008000
 417 #define QE_CMXUCR_TSA                   0x00004000
 418 #define QE_CMXUCR_BKPT                  0x00000100
 419 #define QE_CMXUCR_TX_CLK_SRC_MASK       0x0000000F
 420
 421 /* QE CMXGCR Registers.
 422 */
 423 #define QE_CMXGCR_MII_ENET_MNG          0x00007000
 424 #define QE_CMXGCR_MII_ENET_MNG_SHIFT    12
 425 #define QE_CMXGCR_USBCS                 0x0000000f
 426 #define QE_CMXGCR_USBCS_CLK3            0x1
 427 #define QE_CMXGCR_USBCS_CLK5            0x2
 428 #define QE_CMXGCR_USBCS_CLK7            0x3
 429 #define QE_CMXGCR_USBCS_CLK9            0x4
 430 #define QE_CMXGCR_USBCS_CLK13           0x5
 431 #define QE_CMXGCR_USBCS_CLK17           0x6
 432 #define QE_CMXGCR_USBCS_CLK19           0x7
 433 #define QE_CMXGCR_USBCS_CLK21           0x8
 434 #define QE_CMXGCR_USBCS_BRG9            0x9
 435 #define QE_CMXGCR_USBCS_BRG10           0xa
 436
 437 /* QE CECR Commands.
 438 */
 439 #define QE_CR_FLG                       0x00010000
 440 #define QE_RESET                        0x80000000
 441 #define QE_INIT_TX_RX                   0x00000000
 442 #define QE_INIT_RX                      0x00000001
 443 #define QE_INIT_TX                      0x00000002
 444 #define QE_ENTER_HUNT_MODE              0x00000003
 445 #define QE_STOP_TX                      0x00000004
 446 #define QE_GRACEFUL_STOP_TX             0x00000005
 447 #define QE_RESTART_TX                   0x00000006
 448 #define QE_CLOSE_RX_BD                  0x00000007
 449 #define QE_SWITCH_COMMAND               0x00000007
 450 #define QE_SET_GROUP_ADDRESS            0x00000008
 451 #define QE_START_IDMA                   0x00000009
 452 #define QE_MCC_STOP_RX                  0x00000009
 453 #define QE_ATM_TRANSMIT                 0x0000000a
 454 #define QE_HPAC_CLEAR_ALL               0x0000000b
 455 #define QE_GRACEFUL_STOP_RX             0x0000001a
 456 #define QE_RESTART_RX                   0x0000001b
 457 #define QE_HPAC_SET_PRIORITY            0x0000010b
 458 #define QE_HPAC_STOP_TX                 0x0000020b
 459 #define QE_HPAC_STOP_RX                 0x0000030b
 460 #define QE_HPAC_GRACEFUL_STOP_TX        0x0000040b
 461 #define QE_HPAC_GRACEFUL_STOP_RX        0x0000050b
 462 #define QE_HPAC_START_TX                0x0000060b
 463 #define QE_HPAC_START_RX                0x0000070b
 464 #define QE_USB_STOP_TX                  0x0000000a
 465 #define QE_USB_RESTART_TX               0x0000000c
 466 #define QE_QMC_STOP_TX                  0x0000000c
 467 #define QE_QMC_STOP_RX                  0x0000000d
 468 #define QE_SS7_SU_FIL_RESET             0x0000000e
 469 /* jonathbr added from here down for 83xx */
 470 #define QE_RESET_BCS                    0x0000000a
 471 #define QE_MCC_INIT_TX_RX_16            0x00000003
 472 #define QE_MCC_STOP_TX                  0x00000004
 473 #define QE_MCC_INIT_TX_1                0x00000005
 474 #define QE_MCC_INIT_RX_1                0x00000006
 475 #define QE_MCC_RESET                    0x00000007
 476 #define QE_SET_TIMER                    0x00000008
 477 #define QE_RANDOM_NUMBER                0x0000000c
 478 #define QE_ATM_MULTI_THREAD_INIT        0x00000011
 479 #define QE_ASSIGN_PAGE                  0x00000012
 480 #define QE_ADD_REMOVE_HASH_ENTRY        0x00000013
 481 #define QE_START_FLOW_CONTROL           0x00000014
 482 #define QE_STOP_FLOW_CONTROL            0x00000015
 483 #define QE_ASSIGN_PAGE_TO_DEVICE        0x00000016
 484
 485 #define QE_ASSIGN_RISC                  0x00000010
 486 #define QE_CR_MCN_NORMAL_SHIFT          6
 487 #define QE_CR_MCN_USB_SHIFT             4
 488 #define QE_CR_MCN_RISC_ASSIGN_SHIFT     8
 489 #define QE_CR_SNUM_SHIFT                17
 490
 491 /* QE CECR Sub Block - sub block of QE command.
 492 */
 493 #define QE_CR_SUBBLOCK_INVALID          0x00000000
 494 #define QE_CR_SUBBLOCK_USB              0x03200000
 495 #define QE_CR_SUBBLOCK_UCCFAST1         0x02000000
 496 #define QE_CR_SUBBLOCK_UCCFAST2         0x02200000
 497 #define QE_CR_SUBBLOCK_UCCFAST3         0x02400000
 498 #define QE_CR_SUBBLOCK_UCCFAST4         0x02600000
 499 #define QE_CR_SUBBLOCK_UCCFAST5         0x02800000
 500 #define QE_CR_SUBBLOCK_UCCFAST6         0x02a00000
 501 #define QE_CR_SUBBLOCK_UCCFAST7         0x02c00000
 502 #define QE_CR_SUBBLOCK_UCCFAST8         0x02e00000
 503 #define QE_CR_SUBBLOCK_UCCSLOW1         0x00000000
 504 #define QE_CR_SUBBLOCK_UCCSLOW2         0x00200000
 505 #define QE_CR_SUBBLOCK_UCCSLOW3         0x00400000
 506 #define QE_CR_SUBBLOCK_UCCSLOW4         0x00600000
 507 #define QE_CR_SUBBLOCK_UCCSLOW5         0x00800000
 508 #define QE_CR_SUBBLOCK_UCCSLOW6         0x00a00000
 509 #define QE_CR_SUBBLOCK_UCCSLOW7         0x00c00000
 510 #define QE_CR_SUBBLOCK_UCCSLOW8         0x00e00000
 511 #define QE_CR_SUBBLOCK_MCC1             0x03800000
 512 #define QE_CR_SUBBLOCK_MCC2             0x03a00000
 513 #define QE_CR_SUBBLOCK_MCC3             0x03000000
 514 #define QE_CR_SUBBLOCK_IDMA1            0x02800000
 515 #define QE_CR_SUBBLOCK_IDMA2            0x02a00000
 516 #define QE_CR_SUBBLOCK_IDMA3            0x02c00000
 517 #define QE_CR_SUBBLOCK_IDMA4            0x02e00000
 518 #define QE_CR_SUBBLOCK_HPAC             0x01e00000
 519 #define QE_CR_SUBBLOCK_SPI1             0x01400000
 520 #define QE_CR_SUBBLOCK_SPI2             0x01600000
 521 #define QE_CR_SUBBLOCK_RAND             0x01c00000
 522 #define QE_CR_SUBBLOCK_TIMER            0x01e00000
 523 #define QE_CR_SUBBLOCK_GENERAL          0x03c00000
 524
 525 /* QE CECR Protocol - For non-MCC, specifies mode for QE CECR command */
 526 #define QE_CR_PROTOCOL_UNSPECIFIED      0x00    /* For all other protocols */
 527 #define QE_CR_PROTOCOL_HDLC_TRANSPARENT 0x00
 528 #define QE_CR_PROTOCOL_QMC              0x02
 529 #define QE_CR_PROTOCOL_UART             0x04
 530 #define QE_CR_PROTOCOL_ATM_POS          0x0A
 531 #define QE_CR_PROTOCOL_ETHERNET         0x0C
 532 #define QE_CR_PROTOCOL_L2_SWITCH        0x0D
 533
 534 /* BRG configuration register */
 535 #define QE_BRGC_ENABLE          0x00010000
 536 #define QE_BRGC_DIVISOR_SHIFT   1
 537 #define QE_BRGC_DIVISOR_MAX     0xFFF
 538 #define QE_BRGC_DIV16           1
 539
 540 /* QE Timers registers */
 541 #define QE_GTCFR1_PCAS  0x80
 542 #define QE_GTCFR1_STP2  0x20
 543 #define QE_GTCFR1_RST2  0x10
 544 #define QE_GTCFR1_GM2   0x08
 545 #define QE_GTCFR1_GM1   0x04
 546 #define QE_GTCFR1_STP1  0x02
 547 #define QE_GTCFR1_RST1  0x01
 548
 549 /* SDMA registers */
 550 #define QE_SDSR_BER1    0x02000000
 551 #define QE_SDSR_BER2    0x01000000
 552
 553 #define QE_SDMR_GLB_1_MSK       0x80000000
 554 #define QE_SDMR_ADR_SEL         0x20000000
 555 #define QE_SDMR_BER1_MSK        0x02000000
 556 #define QE_SDMR_BER2_MSK        0x01000000
 557 #define QE_SDMR_EB1_MSK         0x00800000
 558 #define QE_SDMR_ER1_MSK         0x00080000
 559 #define QE_SDMR_ER2_MSK         0x00040000
 560 #define QE_SDMR_CEN_MASK        0x0000E000
 561 #define QE_SDMR_SBER_1          0x00000200
 562 #define QE_SDMR_SBER_2          0x00000200
 563 #define QE_SDMR_EB1_PR_MASK     0x000000C0
 564 #define QE_SDMR_ER1_PR          0x00000008
 565
 566 #define QE_SDMR_CEN_SHIFT       13
 567 #define QE_SDMR_EB1_PR_SHIFT    6
 568
 569 #define QE_SDTM_MSNUM_SHIFT     24
 570
 571 #define QE_SDEBCR_BA_MASK       0x01FFFFFF
 572
 573 /* Communication Processor */
 574 #define QE_CP_CERCR_MEE         0x8000  /* Multi-user RAM ECC enable */
 575 #define QE_CP_CERCR_IEE         0x4000  /* Instruction RAM ECC enable */
 576 #define QE_CP_CERCR_CIR         0x0800  /* Common instruction RAM */
 577
 578 /* I-RAM */
 579 #define QE_IRAM_IADD_AIE        0x80000000      /* Auto Increment Enable */
 580 #define QE_IRAM_IADD_BADDR      0x00080000      /* Base Address */
 581 #define QE_IRAM_READY           0x80000000      /* Ready */
 582
 583 /* UPC */
 584 #define UPGCR_PROTOCOL  0x80000000      /* protocol ul2 or pl2 */
 585 #define UPGCR_TMS       0x40000000      /* Transmit master/slave mode */
 586 #define UPGCR_RMS       0x20000000      /* Receive master/slave mode */
 587 #define UPGCR_ADDR      0x10000000      /* Master MPHY Addr multiplexing */
 588 #define UPGCR_DIAG      0x01000000      /* Diagnostic mode */
 589
 590 /* UCC GUEMR register */
 591 #define UCC_GUEMR_MODE_MASK_RX  0x02
 592 #define UCC_GUEMR_MODE_FAST_RX  0x02
 593 #define UCC_GUEMR_MODE_SLOW_RX  0x00
 594 #define UCC_GUEMR_MODE_MASK_TX  0x01
 595 #define UCC_GUEMR_MODE_FAST_TX  0x01
 596 #define UCC_GUEMR_MODE_SLOW_TX  0x00
 597 #define UCC_GUEMR_MODE_MASK (UCC_GUEMR_MODE_MASK_RX | UCC_GUEMR_MODE_MASK_TX)
 598 #define UCC_GUEMR_SET_RESERVED3 0x10    /* Bit 3 in the guemr is reserved but
 599                                            must be set 1 */
 600
 601 /* structure representing UCC SLOW parameter RAM */
 602 struct ucc_slow_pram {
 603         __be16 rbase;           /* RX BD base address */
 604         __be16 tbase;           /* TX BD base address */
 605         u8 rbmr;                /* RX bus mode register (same as CPM's RFCR) */
 606         u8 tbmr;                /* TX bus mode register (same as CPM's TFCR) */
 607         __be16 mrblr;           /* Rx buffer length */
 608         __be32 rstate;          /* Rx internal state */
 609         __be32 rptr;            /* Rx internal data pointer */
 610         __be16 rbptr;           /* rb BD Pointer */
 611         __be16 rcount;          /* Rx internal byte count */
 612         __be32 rtemp;           /* Rx temp */
 613         __be32 tstate;          /* Tx internal state */
 614         __be32 tptr;            /* Tx internal data pointer */
 615         __be16 tbptr;           /* Tx BD pointer */
 616         __be16 tcount;          /* Tx byte count */
 617         __be32 ttemp;           /* Tx temp */
 618         __be32 rcrc;            /* temp receive CRC */
 619         __be32 tcrc;            /* temp transmit CRC */
 620 } __attribute__ ((packed));
 621
 622 /* General UCC SLOW Mode Register (GUMRH & GUMRL) */
 623 #define UCC_SLOW_GUMR_H_SAM_QMC         0x00000000
 624 #define UCC_SLOW_GUMR_H_SAM_SATM        0x00008000
 625 #define UCC_SLOW_GUMR_H_REVD            0x00002000
 626 #define UCC_SLOW_GUMR_H_TRX             0x00001000
 627 #define UCC_SLOW_GUMR_H_TTX             0x00000800
 628 #define UCC_SLOW_GUMR_H_CDP             0x00000400
 629 #define UCC_SLOW_GUMR_H_CTSP            0x00000200
 630 #define UCC_SLOW_GUMR_H_CDS             0x00000100
 631 #define UCC_SLOW_GUMR_H_CTSS            0x00000080
 632 #define UCC_SLOW_GUMR_H_TFL             0x00000040
 633 #define UCC_SLOW_GUMR_H_RFW             0x00000020
 634 #define UCC_SLOW_GUMR_H_TXSY            0x00000010
 635 #define UCC_SLOW_GUMR_H_4SYNC           0x00000004
 636 #define UCC_SLOW_GUMR_H_8SYNC           0x00000008
 637 #define UCC_SLOW_GUMR_H_16SYNC          0x0000000c
 638 #define UCC_SLOW_GUMR_H_RTSM            0x00000002
 639 #define UCC_SLOW_GUMR_H_RSYN            0x00000001
 640
 641 #define UCC_SLOW_GUMR_L_TCI             0x10000000
 642 #define UCC_SLOW_GUMR_L_RINV            0x02000000
 643 #define UCC_SLOW_GUMR_L_TINV            0x01000000
 644 #define UCC_SLOW_GUMR_L_TEND            0x00040000
 645 #define UCC_SLOW_GUMR_L_TDCR_MASK       0x00030000
 646 #define UCC_SLOW_GUMR_L_TDCR_32         0x00030000
 647 #define UCC_SLOW_GUMR_L_TDCR_16         0x00020000
 648 #define UCC_SLOW_GUMR_L_TDCR_8          0x00010000
 649 #define UCC_SLOW_GUMR_L_TDCR_1          0x00000000
 650 #define UCC_SLOW_GUMR_L_RDCR_MASK       0x0000c000
 651 #define UCC_SLOW_GUMR_L_RDCR_32         0x0000c000
 652 #define UCC_SLOW_GUMR_L_RDCR_16         0x00008000
 653 #define UCC_SLOW_GUMR_L_RDCR_8          0x00004000
 654 #define UCC_SLOW_GUMR_L_RDCR_1          0x00000000
 655 #define UCC_SLOW_GUMR_L_RENC_NRZI       0x00000800
 656 #define UCC_SLOW_GUMR_L_RENC_NRZ        0x00000000
 657 #define UCC_SLOW_GUMR_L_TENC_NRZI       0x00000100
 658 #define UCC_SLOW_GUMR_L_TENC_NRZ        0x00000000
 659 #define UCC_SLOW_GUMR_L_DIAG_MASK       0x000000c0
 660 #define UCC_SLOW_GUMR_L_DIAG_LE         0x000000c0
 661 #define UCC_SLOW_GUMR_L_DIAG_ECHO       0x00000080
 662 #define UCC_SLOW_GUMR_L_DIAG_LOOP       0x00000040
 663 #define UCC_SLOW_GUMR_L_DIAG_NORM       0x00000000
 664 #define UCC_SLOW_GUMR_L_ENR             0x00000020
 665 #define UCC_SLOW_GUMR_L_ENT             0x00000010
 666 #define UCC_SLOW_GUMR_L_MODE_MASK       0x0000000F
 667 #define UCC_SLOW_GUMR_L_MODE_BISYNC     0x00000008
 668 #define UCC_SLOW_GUMR_L_MODE_AHDLC      0x00000006
 669 #define UCC_SLOW_GUMR_L_MODE_UART       0x00000004
 670 #define UCC_SLOW_GUMR_L_MODE_QMC        0x00000002
 671
 672 /* General UCC FAST Mode Register */
 673 #define UCC_FAST_GUMR_LOOPBACK  0x40000000
 674 #define UCC_FAST_GUMR_TCI       0x20000000
 675 #define UCC_FAST_GUMR_TRX       0x10000000
 676 #define UCC_FAST_GUMR_TTX       0x08000000
 677 #define UCC_FAST_GUMR_CDP       0x04000000
 678 #define UCC_FAST_GUMR_CTSP      0x02000000
 679 #define UCC_FAST_GUMR_CDS       0x01000000
 680 #define UCC_FAST_GUMR_CTSS      0x00800000
 681 #define UCC_FAST_GUMR_TXSY      0x00020000
 682 #define UCC_FAST_GUMR_RSYN      0x00010000
 683 #define UCC_FAST_GUMR_SYNL_MASK 0x0000C000
 684 #define UCC_FAST_GUMR_SYNL_16   0x0000C000
 685 #define UCC_FAST_GUMR_SYNL_8    0x00008000
 686 #define UCC_FAST_GUMR_SYNL_AUTO 0x00004000
 687 #define UCC_FAST_GUMR_RTSM      0x00002000
 688 #define UCC_FAST_GUMR_REVD      0x00000400
 689 #define UCC_FAST_GUMR_ENR       0x00000020
 690 #define UCC_FAST_GUMR_ENT       0x00000010
 691
 692 /* UART Slow UCC Event Register (UCCE) */
 693 #define UCC_UART_UCCE_AB        0x0200
 694 #define UCC_UART_UCCE_IDLE      0x0100
 695 #define UCC_UART_UCCE_GRA       0x0080
 696 #define UCC_UART_UCCE_BRKE      0x0040
 697 #define UCC_UART_UCCE_BRKS      0x0020
 698 #define UCC_UART_UCCE_CCR       0x0008
 699 #define UCC_UART_UCCE_BSY       0x0004
 700 #define UCC_UART_UCCE_TX        0x0002
 701 #define UCC_UART_UCCE_RX        0x0001
 702
 703 /* HDLC Slow UCC Event Register (UCCE) */
 704 #define UCC_HDLC_UCCE_GLR       0x1000
 705 #define UCC_HDLC_UCCE_GLT       0x0800
 706 #define UCC_HDLC_UCCE_IDLE      0x0100
 707 #define UCC_HDLC_UCCE_BRKE      0x0040
 708 #define UCC_HDLC_UCCE_BRKS      0x0020
 709 #define UCC_HDLC_UCCE_TXE       0x0010
 710 #define UCC_HDLC_UCCE_RXF       0x0008
 711 #define UCC_HDLC_UCCE_BSY       0x0004
 712 #define UCC_HDLC_UCCE_TXB       0x0002
 713 #define UCC_HDLC_UCCE_RXB       0x0001
 714
 715 /* BISYNC Slow UCC Event Register (UCCE) */
 716 #define UCC_BISYNC_UCCE_GRA     0x0080
 717 #define UCC_BISYNC_UCCE_TXE     0x0010
 718 #define UCC_BISYNC_UCCE_RCH     0x0008
 719 #define UCC_BISYNC_UCCE_BSY     0x0004
 720 #define UCC_BISYNC_UCCE_TXB     0x0002
 721 #define UCC_BISYNC_UCCE_RXB     0x0001
 722
 723 /* Gigabit Ethernet Fast UCC Event Register (UCCE) */
 724 #define UCC_GETH_UCCE_MPD       0x80000000
 725 #define UCC_GETH_UCCE_SCAR      0x40000000
 726 #define UCC_GETH_UCCE_GRA       0x20000000
 727 #define UCC_GETH_UCCE_CBPR      0x10000000
 728 #define UCC_GETH_UCCE_BSY       0x08000000
 729 #define UCC_GETH_UCCE_RXC       0x04000000
 730 #define UCC_GETH_UCCE_TXC       0x02000000
 731 #define UCC_GETH_UCCE_TXE       0x01000000
 732 #define UCC_GETH_UCCE_TXB7      0x00800000
 733 #define UCC_GETH_UCCE_TXB6      0x00400000
 734 #define UCC_GETH_UCCE_TXB5      0x00200000
 735 #define UCC_GETH_UCCE_TXB4      0x00100000
 736 #define UCC_GETH_UCCE_TXB3      0x00080000
 737 #define UCC_GETH_UCCE_TXB2      0x00040000
 738 #define UCC_GETH_UCCE_TXB1      0x00020000
 739 #define UCC_GETH_UCCE_TXB0      0x00010000
 740 #define UCC_GETH_UCCE_RXB7      0x00008000
 741 #define UCC_GETH_UCCE_RXB6      0x00004000
 742 #define UCC_GETH_UCCE_RXB5      0x00002000
 743 #define UCC_GETH_UCCE_RXB4      0x00001000
 744 #define UCC_GETH_UCCE_RXB3      0x00000800
 745 #define UCC_GETH_UCCE_RXB2      0x00000400
 746 #define UCC_GETH_UCCE_RXB1      0x00000200
 747 #define UCC_GETH_UCCE_RXB0      0x00000100
 748 #define UCC_GETH_UCCE_RXF7      0x00000080
 749 #define UCC_GETH_UCCE_RXF6      0x00000040
 750 #define UCC_GETH_UCCE_RXF5      0x00000020
 751 #define UCC_GETH_UCCE_RXF4      0x00000010
 752 #define UCC_GETH_UCCE_RXF3      0x00000008
 753 #define UCC_GETH_UCCE_RXF2      0x00000004
 754 #define UCC_GETH_UCCE_RXF1      0x00000002
 755 #define UCC_GETH_UCCE_RXF0      0x00000001
 756
 757 /* UCC Protocol Specific Mode Register (UPSMR), when used for UART */
 758 #define UCC_UART_UPSMR_FLC              0x8000
 759 #define UCC_UART_UPSMR_SL               0x4000
 760 #define UCC_UART_UPSMR_CL_MASK          0x3000
 761 #define UCC_UART_UPSMR_CL_8             0x3000
 762 #define UCC_UART_UPSMR_CL_7             0x2000
 763 #define UCC_UART_UPSMR_CL_6             0x1000
 764 #define UCC_UART_UPSMR_CL_5             0x0000
 765 #define UCC_UART_UPSMR_UM_MASK          0x0c00
 766 #define UCC_UART_UPSMR_UM_NORMAL        0x0000
 767 #define UCC_UART_UPSMR_UM_MAN_MULTI     0x0400
 768 #define UCC_UART_UPSMR_UM_AUTO_MULTI    0x0c00
 769 #define UCC_UART_UPSMR_FRZ              0x0200
 770 #define UCC_UART_UPSMR_RZS              0x0100
 771 #define UCC_UART_UPSMR_SYN              0x0080
 772 #define UCC_UART_UPSMR_DRT              0x0040
 773 #define UCC_UART_UPSMR_PEN              0x0010
 774 #define UCC_UART_UPSMR_RPM_MASK         0x000c
 775 #define UCC_UART_UPSMR_RPM_ODD          0x0000
 776 #define UCC_UART_UPSMR_RPM_LOW          0x0004
 777 #define UCC_UART_UPSMR_RPM_EVEN         0x0008
 778 #define UCC_UART_UPSMR_RPM_HIGH         0x000C
 779 #define UCC_UART_UPSMR_TPM_MASK         0x0003
 780 #define UCC_UART_UPSMR_TPM_ODD          0x0000
 781 #define UCC_UART_UPSMR_TPM_LOW          0x0001
 782 #define UCC_UART_UPSMR_TPM_EVEN         0x0002
 783 #define UCC_UART_UPSMR_TPM_HIGH         0x0003
 784
 785 /* UCC Protocol Specific Mode Register (UPSMR), when used for Ethernet */
 786 #define UCC_GETH_UPSMR_FTFE     0x80000000
 787 #define UCC_GETH_UPSMR_PTPE     0x40000000
 788 #define UCC_GETH_UPSMR_ECM      0x04000000
 789 #define UCC_GETH_UPSMR_HSE      0x02000000
 790 #define UCC_GETH_UPSMR_PRO      0x00400000
 791 #define UCC_GETH_UPSMR_CAP      0x00200000
 792 #define UCC_GETH_UPSMR_RSH      0x00100000
 793 #define UCC_GETH_UPSMR_RPM      0x00080000
 794 #define UCC_GETH_UPSMR_R10M     0x00040000
 795 #define UCC_GETH_UPSMR_RLPB     0x00020000
 796 #define UCC_GETH_UPSMR_TBIM     0x00010000
 797 #define UCC_GETH_UPSMR_RES1     0x00002000
 798 #define UCC_GETH_UPSMR_RMM      0x00001000
 799 #define UCC_GETH_UPSMR_CAM      0x00000400
 800 #define UCC_GETH_UPSMR_BRO      0x00000200
 801 #define UCC_GETH_UPSMR_SMM      0x00000080
 802 #define UCC_GETH_UPSMR_SGMM     0x00000020
 803
 804 /* UCC Protocol Specific Mode Register (UPSMR), when used for HDLC */
 805 #define UCC_HDLC_UPSMR_RTE      0x02000000
 806 #define UCC_HDLC_UPSMR_BUS      0x00200000
 807 #define UCC_HDLC_UPSMR_CW8      0x00007000
 808
 809 /* UCC Transmit On Demand Register (UTODR) */
 810 #define UCC_SLOW_TOD    0x8000
 811 #define UCC_FAST_TOD    0x8000
 812
 813 /* UCC Bus Mode Register masks */
 814 /* Not to be confused with the Bundle Mode Register */
 815 #define UCC_BMR_GBL             0x20
 816 #define UCC_BMR_BO_BE           0x10
 817 #define UCC_BMR_CETM            0x04
 818 #define UCC_BMR_DTB             0x02
 819 #define UCC_BMR_BDB             0x01
 820
 821 /* Function code masks */
 822 #define FC_GBL                          0x20
 823 #define FC_DTB_LCL                      0x02
 824 #define UCC_FAST_FUNCTION_CODE_GBL      0x20
 825 #define UCC_FAST_FUNCTION_CODE_DTB_LCL  0x02
 826 #define UCC_FAST_FUNCTION_CODE_BDB_LCL  0x01
 827
 828 #endif /* __KERNEL__ */
 829 #endif /* _ASM_POWERPC_QE_H */