linux uart驱动——相关数据结构以及API(二)

一、核心数据结构
      串口驱动有3个核心数据结构，它们都定义在<#include linux/serial_core.h>
1、uart_driver
     uart_driver包含了串口设备名、串口驱动名、主次设备号、串口控制台(可选)等信息，还封装了tty_driver(底层串口驱动无需关心tty_driver)。

struct uart_driver {
    struct module    *owner;      /* 拥有该uart_driver的模块,一般为THIS_MODULE */
    const char    *driver_name; /* 串口驱动名，串口设备文件名以驱动名为基础 */
    const char    *dev_name;      /* 串口设备名 */
    int             major;          /* 主设备号 */
    int             minor;          /* 次设备号 */
    int             nr;          /* 该uart_driver支持的串口个数(最大) */
    struct console    *cons;    /* 其对应的console.若该uart_driver支持serial console,否则为NULL */

    /*
     * these are private; the low level driver should not
     * touch these; they should be initialised to NULL
     */
    struct uart_state    *state;
    struct tty_driver    *tty_driver;
};

2、uart_port
      uart_port用于描述串口端口的I/O端口或I/O内存地址、FIFO大小、端口类型、串口时钟等信息。实际上，一个uart_port实例对应一个串口设备

struct uart_port {
    spinlock_t        lock;            /* port lock 串口端口锁 */
    unsigned long        iobase;        /* in/out[bwl] io端口基地 */
    unsigned char __iomem    *membase;/* read/write[bwl] IO内存基地址,经映射(如ioremap)后的IO内存虚拟基地址 */
    unsigned int        (*serial_in)(struct uart_port *, int);
    void            (*serial_out)(struct uart_port *, int, int);
    void            (*set_termios)(struct uart_port *,
                               struct ktermios *new,
                               struct ktermios *old);
    void            (*pm)(struct uart_port *, unsigned int state,
                      unsigned int old);
    unsigned int        irq;            /* irq number */
    unsigned long        irqflags;        /* irq flags  */
    unsigned int        uartclk;        /* base uart clock */
    unsigned int        fifosize;        /* tx fifo size */
    unsigned char        x_char;            /* xon/xoff char */
    unsigned char        regshift;        /* reg offset shift */
    unsigned char        iotype;            /* io access style */
    unsigned char        unused1;

#define UPIO_PORT        (0)
#define UPIO_HUB6        (1)
#define UPIO_MEM        (2)
#define UPIO_MEM32        (3)
#define UPIO_AU            (4)            /* Au1x00 type IO */
#define UPIO_TSI        (5)            /* Tsi108/109 type IO */
#define UPIO_DWAPB        (6)            /* DesignWare APB UART */
#define UPIO_RM9000        (7)            /* RM9000 type IO */
#define UPIO_DWAPB32        (8)            /* DesignWare APB UART (32 bit accesses) */

    unsigned int        read_status_mask;    /* driver specific */
    unsigned int        ignore_status_mask;    /* driver specific */
    struct uart_state    *state;            /* pointer to parent state */
    struct uart_icount    icount;            /* statistics */

    struct console        *cons;            /* struct console, if any */
#if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
    unsigned long        sysrq;            /* sysrq timeout */
#endif

    upf_t            flags;

#define UPF_FOURPORT        ((__force upf_t) (1 << 1))
#define UPF_SAK            ((__force upf_t) (1 << 2))
#define UPF_SPD_MASK        ((__force upf_t) (0x1030))
#define UPF_SPD_HI        ((__force upf_t) (0x0010))
#define UPF_SPD_VHI        ((__force upf_t) (0x0020))
#define UPF_SPD_CUST        ((__force upf_t) (0x0030))
#define UPF_SPD_SHI        ((__force upf_t) (0x1000))
#define UPF_SPD_WARP        ((__force upf_t) (0x1010))
#define UPF_SKIP_TEST        ((__force upf_t) (1 << 6))
#define UPF_AUTO_IRQ        ((__force upf_t) (1 << 7))
#define UPF_HARDPPS_CD        ((__force upf_t) (1 << 11))
#define UPF_LOW_LATENCY        ((__force upf_t) (1 << 13))
#define UPF_BUGGY_UART        ((__force upf_t) (1 << 14))
#define UPF_NO_TXEN_TEST    ((__force upf_t) (1 << 15))
#define UPF_MAGIC_MULTIPLIER    ((__force upf_t) (1 << 16))
#define UPF_CONS_FLOW        ((__force upf_t) (1 << 23))
#define UPF_SHARE_IRQ        ((__force upf_t) (1 << 24))
/* The exact UART type is known and should not be probed.  */
#define UPF_FIXED_TYPE        ((__force upf_t) (1 << 27))
#define UPF_BOOT_AUTOCONF    ((__force upf_t) (1 << 28))
#define UPF_FIXED_PORT        ((__force upf_t) (1 << 29))
#define UPF_DEAD        ((__force upf_t) (1 << 30))
#define UPF_IOREMAP        ((__force upf_t) (1 << 31))

#define UPF_CHANGE_MASK        ((__force upf_t) (0x17fff))
#define UPF_USR_MASK        ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))

    unsigned int        mctrl;            /* current modem ctrl settings */
    unsigned int        timeout;        /* character-based timeout */
    unsigned int        type;            /* port type */
    const struct uart_ops    *ops;
    unsigned int        custom_divisor;
    unsigned int        line;            /* port index */
    resource_size_t        mapbase;        /* for ioremap */
    struct device        *dev;            /* parent device */
    unsigned char        hub6;            /* this should be in the 8250 driver */
    unsigned char        suspended;
    unsigned char        irq_wake;
    unsigned char        unused[2];
    void            *private_data;        /* generic platform data pointer */
};.csharpcode, .csharpcode pre { font-size: small; color: rgba(0, 0, 0, 1); font-family: consolas, "Courier New", courier, monospace; background-color: rgba(255, 255, 255, 1) }
.csharpcode pre { margin: 0 }
.csharpcode .rem { color: rgba(0, 128, 0, 1) }
.csharpcode .kwrd { color: rgba(0, 0, 255, 1) }
.csharpcode .str { color: rgba(0, 96, 128, 1) }
.csharpcode .op { color: rgba(0, 0, 192, 1) }
.csharpcode .preproc { color: rgba(204, 102, 51, 1) }
.csharpcode .asp { background-color: rgba(255, 255, 0, 1) }
.csharpcode .html { color: rgba(128, 0, 0, 1) }
.csharpcode .attr { color: rgba(255, 0, 0, 1) }
.csharpcode .alt { background-color: rgba(244, 244, 244, 1); width: 100%; margin: 0 }
.csharpcode .lnum { color: rgba(96, 96, 96, 1) }

     uart_iconut为串口信息计数器，包含了发送字符计数、接收字符计数等。在串口的发送中断处理函数和接收中断处理函数中，我们需要管理这些计数。

struct uart_icount {
    __u32    cts;
    __u32    dsr;
    __u32    rng;
    __u32    dcd;
    __u32    rx;      /* 发送字符计数 */
    __u32    tx;      /* 接受字符计数 */
    __u32    frame;   /* 帧错误计数 */
    __u32    overrun; /* Rx FIFO溢出计数 */
    __u32    parity;  /* 帧校验错误计数 */
    __u32    brk;     /* break计数 */
    __u32    buf_overrun;
};

      uart_stat有两个成员在底层串口驱动会用到：xmit和port。用户空间程序通过串口发送数据时，上层驱动将用户数据保存在xmit；而串口发送中断处理函数就是通过xmit获取到用户数据并将它们发送出去。串口接收中断处理函数需要通过port将接收到的数据传递给行规则层。

/*
 * This is the state information which is persistent across opens.
 */
struct uart_state {
    struct tty_port        port;

    int            pm_state;
    struct circ_buf        xmit;

    struct tasklet_struct    tlet;
    struct uart_port    *uart_port;
};

3、uart_ops

uart_ops涵盖了串口驱动可对串口设备进行的所有操作

/*
 * This structure describes all the operations that can be
 * done on the physical hardware.
 */
struct uart_ops {
    unsigned int    (*tx_empty)(struct uart_port *);/* 串口的Tx FIFO缓存是否为空 */
    void        (*set_mctrl)(struct uart_port *, unsigned int mctrl);/* 设置串口modem控制 */
    unsigned int    (*get_mctrl)(struct uart_port *); /* 获取串口modem控制 */
    void        (*stop_tx)(struct uart_port *);/* 禁止串口发送数据 */
    void        (*start_tx)(struct uart_port *);/* 使能串口发送数据 */
    void        (*send_xchar)(struct uart_port *, char ch);/* 发送xChar */
    void        (*stop_rx)(struct uart_port *);/* 禁止串口接收数据 */
    void        (*enable_ms)(struct uart_port *);/* 使能modem的状态信号 */
    void        (*break_ctl)(struct uart_port *, int ctl); /* 设置break信号 */
    int        (*startup)(struct uart_port *);/* 启动串口,应用程序打开串口设备文件时,该函数会被调用 */
    void        (*shutdown)(struct uart_port *);/* 关闭串口,应用程序关闭串口设备文件时,该函数会被调用 */
    void        (*flush_buffer)(struct uart_port *);
    void        (*set_termios)(struct uart_port *, struct ktermios *new,
                       struct ktermios *old);/* 设置串口参数 */
    void        (*set_ldisc)(struct uart_port *, int new);
    void        (*pm)(struct uart_port *, unsigned int state,
                  unsigned int oldstate);/* 串口电源管理 */
    int        (*set_wake)(struct uart_port *, unsigned int state);
    void        (*wake_peer)(struct uart_port *);

    /*
     * Return a string describing the type of the port
     */
    const char *(*type)(struct uart_port *);/* 返回一描述串口类型的字符串 */

    /*
     * Release IO and memory resources used by the port.
     * This includes iounmap if necessary.
     */
    void        (*release_port)(struct uart_port *);/* 释放串口已申请的IO端口/IO内存资源,必要时还需iounmap */

    /*
     * Request IO and memory resources used by the port.
     * This includes iomapping the port if necessary.
     */
    int        (*request_port)(struct uart_port *); /* 申请必要的IO端口/IO内存资源,必要时还可以重新映射串口端口 */
    void        (*config_port)(struct uart_port *, int);/* 执行串口所需的自动配置 */
    int        (*verify_port)(struct uart_port *, struct serial_struct *);/* 验证串口所需的自动配置 */
    int        (*ioctl)(struct uart_port *, unsigned int, unsigned long);
#ifdef CONFIG_CONSOLE_POLL
    void    (*poll_put_char)(struct uart_port *, unsigned char);
    int        (*poll_get_char)(struct uart_port *);
#endif
};

 

二、串口驱动API

1、uart_register_driver

/  * 功能:uart_register_driver用于将串口驱动uart_driver注册到内核(串口核心层)中，通常在模块初始化函数调用该函数。
   * 参数 drv：要注册的uart_driver
   * 返回值：  成功，返回0；否则返回错误码
*/
  int uart_register_driver(struct uart_driver *drv)

2、uart_unregister_driver

/* 功能：    uart_unregister_driver用于注销我们已注册的uart_driver，通常在模块卸载函数调用该函数
 * 参数 drv：要注销的uart_driver

 * 返回值：  成功，返回0；否则返回错误码
 */
void uart_unregister_driver(struct uart_driver *drv)

3、uart_add_one_port

/* 功能：    uart_add_one_port用于为串口驱动添加一个串口端口，通常在探测到设备后(驱动的设备probe方法)调用该函数
 * 参数 drv：串口驱动
 *      port:要添加的串口端口

 * 返回值：  成功，返回0；否则返回错误码
 */
int uart_add_one_port(struct uart_driver *drv, struct uart_port *port)

4、uart_remove_one_port

/* 功能：     uart_remove_one_port用于删除一个已添加到串口驱动中的串口端口，通常在驱动卸载时调用该函数
 * 参数 drv： 串口驱动
 *      port: 要删除的串口端口
 * 返回值：   成功，返回0；否则返回错误码
 */
int uart_remove_one_port(struct uart_driver *drv, struct uart_port *port)

5、uart_write_wakeup

/* 功能：     uart_write_wakeup唤醒上层因向串口端口写数据而阻塞的进程，通常在串口发送中断处理函数中调用该函数
 * 参数 port：需要唤醒写阻塞进程的串口端口
 */
void uart_write_wakeup(struct uart_port *port)

6、uart_suspend_port

/* 功能：     uart_suspend_port用于挂起特定的串口端口
 * 参数 drv： 要挂起的串口端口所属的串口驱动
 *      port：要挂起的串口端口
 * 返回值：   成功返回0；否则返回错误码
 */
int uart_suspend_port(struct uart_driver *drv, struct uart_port *port)

7、uart_resume_port

/* 功能：     uart_resume_port用于恢复某一已挂起的串口
 * 参数 drv： 要恢复的串口端口所属的串口驱动
 *      port：要恢复的串口端口
 * 返回值：   成功返回0；否则返回错误码
 */
int uart_resume_port(struct uart_driver *drv, struct uart_port *port)

8、uart_get_baud_rate

/* 功能：        uart_get_baud_rate通过解码termios结构体来获取指定串口的波特率
 * 参数 port：  要获取波特率的串口端口
 *     termios：当前期望的termios配置(包含串口波特率)
 *     old：    以前的termios配置，可以为NULL
 *     min：    可接受的最小波特率
 *     max：    可接受的最大波特率
 * 返回值：     串口的波特率
 */
unsigned int
uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
struct ktermios *old, unsigned int min, unsigned int max)

9、uart_get_divisor

/* 功能：     uart_get_divisor用于计算某一波特率的串口时钟分频数（串口波特率除数）
 * 参数 port：要计算时钟分频数的串口端口
 *      baud：期望的波特率
 *返回值：    串口时钟分频数
 */
unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud)

10、uart_update_timeout

/* 功能：      uart_update_timeout用于更新（设置）串口FIFO超时时间
 * 参数 port： 要更新超时时间的串口端口
 *     cflag：termios结构体的cflag值
 *     baud： 串口的波特率
 */
void uart_update_timeout(struct uart_port *port, unsigned int cflag, unsigned int baud)

11、uart_match_port

/* 功能：uart_match_port用于判断两串口端口是否为同一端口
 * 参数 port1、port2：要判断的串口端口
 * 返回值：不同返回0；否则返回非0
 */
int uart_match_port(struct uart_port *port1, struct uart_port *port2)

12、uart_console_write

/* 功能：        uart_console_write用于向串口端口写一控制台信息

 * 参数 port:    要写信息的串口端口
 *     s:       要写的信息
 *     count:   信息的大小
 *     putchar: 用于向串口端口写字符的函数，该函数函数有两个参数：串口端口和要写的字符
 */
void uart_console_write(struct uart_port *port, const char *s,
unsigned int count,
void (*putchar)(struct uart_port *, int))