colibri_imx6: fix video stdout in default environment
[oweals/u-boot.git] / include / serial.h
index 66ed12c9c218840afe59631818a58f1bb433279d..c590637b1f3bade45cea412b1076a848f78f0ad9 100644 (file)
@@ -26,13 +26,9 @@ extern struct serial_device serial_smc_device;
 extern struct serial_device serial_scc_device;
 extern struct serial_device *default_serial_console(void);
 
-#if    defined(CONFIG_405GP) || \
-       defined(CONFIG_405EP) || defined(CONFIG_405EZ) || \
-       defined(CONFIG_405EX) || defined(CONFIG_440) || \
-       defined(CONFIG_MB86R0x) || defined(CONFIG_MPC5xxx) || \
-       defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
-       defined(CONFIG_MPC86xx) || defined(CONFIG_SYS_SC520) || \
-       defined(CONFIG_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
+#if    defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx) || \
+       defined(CONFIG_MPC86xx) || \
+       defined(CONFIG_ARCH_TEGRA) || defined(CONFIG_SYS_COREBOOT) || \
        defined(CONFIG_MICROBLAZE)
 extern struct serial_device serial0_device;
 extern struct serial_device serial1_device;
@@ -40,6 +36,10 @@ extern struct serial_device serial1_device;
 
 extern struct serial_device eserial1_device;
 extern struct serial_device eserial2_device;
+extern struct serial_device eserial3_device;
+extern struct serial_device eserial4_device;
+extern struct serial_device eserial5_device;
+extern struct serial_device eserial6_device;
 
 extern void serial_register(struct serial_device *);
 extern void serial_initialize(void);
@@ -50,30 +50,112 @@ extern void serial_reinit_all(void);
 /* For usbtty */
 #ifdef CONFIG_USB_TTY
 
-extern int usbtty_getc(void);
-extern void usbtty_putc(const char c);
-extern void usbtty_puts(const char *str);
-extern int usbtty_tstc(void);
+struct stdio_dev;
+
+int usbtty_getc(struct stdio_dev *dev);
+void usbtty_putc(struct stdio_dev *dev, const char c);
+void usbtty_puts(struct stdio_dev *dev, const char *str);
+int usbtty_tstc(struct stdio_dev *dev);
 
 #else
 
 /* stubs */
-#define usbtty_getc() 0
-#define usbtty_putc(a)
-#define usbtty_puts(a)
-#define usbtty_tstc() 0
+#define usbtty_getc(dev) 0
+#define usbtty_putc(dev, a)
+#define usbtty_puts(dev, a)
+#define usbtty_tstc(dev) 0
 
 #endif /* CONFIG_USB_TTY */
 
-#if defined(CONFIG_MPC512X)
-extern struct stdio_dev *open_port(int num, int baudrate);
-extern int close_port(int num);
-extern int write_port(struct stdio_dev *port, char *buf);
-extern int read_port(struct stdio_dev *port, char *buf, int size);
-#endif
-
 struct udevice;
 
+enum serial_par {
+       SERIAL_PAR_NONE,
+       SERIAL_PAR_ODD,
+       SERIAL_PAR_EVEN
+};
+
+#define SERIAL_PAR_SHIFT       0
+#define SERIAL_PAR_MASK                (0x03 << SERIAL_PAR_SHIFT)
+#define SERIAL_SET_PARITY(parity) \
+       ((parity << SERIAL_PAR_SHIFT) & SERIAL_PAR_MASK)
+#define SERIAL_GET_PARITY(config) \
+       ((config & SERIAL_PAR_MASK) >> SERIAL_PAR_SHIFT)
+
+enum serial_bits {
+       SERIAL_5_BITS,
+       SERIAL_6_BITS,
+       SERIAL_7_BITS,
+       SERIAL_8_BITS
+};
+
+#define SERIAL_BITS_SHIFT      2
+#define SERIAL_BITS_MASK       (0x3 << SERIAL_BITS_SHIFT)
+#define SERIAL_SET_BITS(bits) \
+       ((bits << SERIAL_BITS_SHIFT) & SERIAL_BITS_MASK)
+#define SERIAL_GET_BITS(config) \
+       ((config & SERIAL_BITS_MASK) >> SERIAL_BITS_SHIFT)
+
+enum serial_stop {
+       SERIAL_HALF_STOP,       /* 0.5 stop bit */
+       SERIAL_ONE_STOP,        /*   1 stop bit */
+       SERIAL_ONE_HALF_STOP,   /* 1.5 stop bit */
+       SERIAL_TWO_STOP         /*   2 stop bit */
+};
+
+#define SERIAL_STOP_SHIFT      4
+#define SERIAL_STOP_MASK       (0x3 << SERIAL_STOP_SHIFT)
+#define SERIAL_SET_STOP(stop) \
+       ((stop << SERIAL_STOP_SHIFT) & SERIAL_STOP_MASK)
+#define SERIAL_GET_STOP(config) \
+       ((config & SERIAL_STOP_MASK) >> SERIAL_STOP_SHIFT)
+
+#define SERIAL_CONFIG(par, bits, stop) \
+                    (par << SERIAL_PAR_SHIFT | \
+                     bits << SERIAL_BITS_SHIFT | \
+                     stop << SERIAL_STOP_SHIFT)
+
+#define SERIAL_DEFAULT_CONFIG \
+                       (SERIAL_PAR_NONE << SERIAL_PAR_SHIFT | \
+                        SERIAL_8_BITS << SERIAL_BITS_SHIFT | \
+                        SERIAL_ONE_STOP << SERIAL_STOP_SHIFT)
+
+enum serial_chip_type {
+       SERIAL_CHIP_UNKNOWN = -1,
+       SERIAL_CHIP_16550_COMPATIBLE,
+};
+
+enum adr_space_type {
+       SERIAL_ADDRESS_SPACE_MEMORY = 0,
+       SERIAL_ADDRESS_SPACE_IO,
+};
+
+/**
+ * struct serial_device_info - structure to hold serial device info
+ *
+ * @type:      type of the UART chip
+ * @addr_space:        address space to access the registers
+ * @addr:      physical address of the registers
+ * @reg_width: size (in bytes) of the IO accesses to the registers
+ * @reg_offset:        offset to apply to the @addr from the start of the registers
+ * @reg_shift: quantity to shift the register offsets by
+ * @clock:     UART base clock speed in Hz
+ * @baudrate:  baud rate
+ */
+struct serial_device_info {
+       enum serial_chip_type type;
+       enum adr_space_type addr_space;
+       ulong addr;
+       u8 reg_width;
+       u8 reg_offset;
+       u8 reg_shift;
+       unsigned int clock;
+       unsigned int baudrate;
+};
+
+#define SERIAL_DEFAULT_ADDRESS 0xBADACCE5
+#define SERIAL_DEFAULT_CLOCK   (16 * 115200)
+
 /**
  * struct struct dm_serial_ops - Driver model serial operations
  *
@@ -150,67 +232,118 @@ struct dm_serial_ops {
         */
        int (*loop)(struct udevice *dev, int on);
 #endif
+
+       /**
+        * getconfig() - Get the uart configuration
+        * (parity, 5/6/7/8 bits word length, stop bits)
+        *
+        * Get a current config for this device.
+        *
+        * @dev: Device pointer
+        * @serial_config: Returns config information (see SERIAL_... above)
+        * @return 0 if OK, -ve on error
+        */
+       int (*getconfig)(struct udevice *dev, uint *serial_config);
+       /**
+        * setconfig() - Set up the uart configuration
+        * (parity, 5/6/7/8 bits word length, stop bits)
+        *
+        * Set up a new config for this device.
+        *
+        * @dev: Device pointer
+        * @serial_config: number of bits, parity and number of stopbits to use
+        * @return 0 if OK, -ve on error
+        */
+       int (*setconfig)(struct udevice *dev, uint serial_config);
+       /**
+        * getinfo() - Get serial device information
+        *
+        * @dev: Device pointer
+        * @info: struct serial_device_info to fill
+        * @return 0 if OK, -ve on error
+        */
+       int (*getinfo)(struct udevice *dev, struct serial_device_info *info);
 };
 
 /**
  * struct serial_dev_priv - information about a device used by the uclass
  *
- * @sdev: stdio device attached to this uart
+ * @sdev:      stdio device attached to this uart
+ *
+ * @buf:       Pointer to the RX buffer
+ * @rd_ptr:    Read pointer in the RX buffer
+ * @wr_ptr:    Write pointer in the RX buffer
  */
 struct serial_dev_priv {
        struct stdio_dev *sdev;
+
+       char *buf;
+       int rd_ptr;
+       int wr_ptr;
 };
 
 /* Access the serial operations for a device */
 #define serial_get_ops(dev)    ((struct dm_serial_ops *)(dev)->driver->ops)
 
-void altera_jtag_serial_initialize(void);
-void altera_serial_initialize(void);
-void amirix_serial_initialize(void);
-void arc_serial_initialize(void);
-void arm_dcc_initialize(void);
-void asc_serial_initialize(void);
+/**
+ * serial_getconfig() - Get the uart configuration
+ * (parity, 5/6/7/8 bits word length, stop bits)
+ *
+ * Get a current config for this device.
+ *
+ * @dev: Device pointer
+ * @serial_config: Returns config information (see SERIAL_... above)
+ * @return 0 if OK, -ve on error
+ */
+int serial_getconfig(struct udevice *dev, uint *config);
+
+/**
+ * serial_setconfig() - Set up the uart configuration
+ * (parity, 5/6/7/8 bits word length, stop bits)
+ *
+ * Set up a new config for this device.
+ *
+ * @dev: Device pointer
+ * @serial_config: number of bits, parity and number of stopbits to use
+ * @return 0 if OK, -ve on error
+ */
+int serial_setconfig(struct udevice *dev, uint config);
+
+/**
+ * serial_getinfo() - Get serial device information
+ *
+ * @dev: Device pointer
+ * @info: struct serial_device_info to fill
+ * @return 0 if OK, -ve on error
+ */
+int serial_getinfo(struct udevice *dev, struct serial_device_info *info);
+
 void atmel_serial_initialize(void);
-void au1x00_serial_initialize(void);
-void bfin_jtag_initialize(void);
-void bfin_serial_initialize(void);
-void bmw_serial_initialize(void);
-void clps7111_serial_initialize(void);
-void cogent_serial_initialize(void);
-void cpci750_serial_initialize(void);
-void evb64260_serial_initialize(void);
-void imx_serial_initialize(void);
-void iop480_serial_initialize(void);
-void jz_serial_initialize(void);
-void ks8695_serial_initialize(void);
-void leon2_serial_initialize(void);
-void leon3_serial_initialize(void);
-void lh7a40x_serial_initialize(void);
-void lpc32xx_serial_initialize(void);
-void marvell_serial_initialize(void);
-void max3100_serial_initialize(void);
 void mcf_serial_initialize(void);
-void ml2_serial_initialize(void);
-void mpc512x_serial_initialize(void);
-void mpc5xx_serial_initialize(void);
-void mpc8260_scc_serial_initialize(void);
-void mpc8260_smc_serial_initialize(void);
 void mpc85xx_serial_initialize(void);
-void mpc8xx_serial_initialize(void);
 void mxc_serial_initialize(void);
-void mxs_auart_initialize(void);
 void ns16550_serial_initialize(void);
-void oc_serial_initialize(void);
-void p3mx_serial_initialize(void);
 void pl01x_serial_initialize(void);
 void pxa_serial_initialize(void);
-void s3c24xx_serial_initialize(void);
-void s5p_serial_initialize(void);
-void sa1100_serial_initialize(void);
-void sandbox_serial_initialize(void);
-void sconsole_serial_initialize(void);
 void sh_serial_initialize(void);
-void uartlite_serial_initialize(void);
-void zynq_serial_initialize(void);
+
+/**
+ * serial_printf() - Write a formatted string to the serial console
+ *
+ * The total size of the output must be less than CONFIG_SYS_PBSIZE.
+ *
+ * @fmt: Printf format string, followed by format arguments
+ * @return number of characters written
+ */
+int serial_printf(const char *fmt, ...)
+               __attribute__ ((format (__printf__, 1, 2)));
+
+int serial_init(void);
+void serial_setbrg(void);
+void serial_putc(const char ch);
+void serial_putc_raw(const char ch);
+void serial_puts(const char *str);
+int serial_getc(void);
+int serial_tstc(void);
 
 #endif