SOC 的协作图:

结构体
struct	xwds_soc_driver
	BSP中需要提供的SOC设备驱动函数表更多...

struct	xwds_soc
	SOC设备更多...

宏定义
#define	__xwds_soc_eirq_tbl_qualifier

#define	__xwds_soc_dma_tbl_qualifier

类型定义
typedef void *	xwds_eirq_arg_t
	外部中断函数参数

typedef void(*	xwds_eirq_f) (struct xwds_soc *, xwid_t, xwds_eirq_arg_t)
	外部中断函数

typedef void *	xwds_dma_cbarg_t
	DMA完成回调函数参数

typedef void(*	xwds_dma_f) (struct xwds_soc *, xwid_t, xwu32_t, xwds_dma_cbarg_t)
	DMA完成回调函数类型

函数
void	xwds_soc_construct (struct xwds_soc *soc)
	XWDS API：SOC构造函数

void	xwds_soc_destruct (struct xwds_soc *soc)
	XWDS API：SOC对象的析构函数

xwer_t	xwds_soc_grab (struct xwds_soc *soc)
	XWDS API：增加对象的引用计数

xwer_t	xwds_soc_put (struct xwds_soc *soc)
	XWDS API：减少对象的引用计数

xwer_t	xwds_soc_get_reset_reason (struct xwds_soc soc, xwu64_t reason)
	XWDS API：获取复位原因

xwer_t	xwds_clk_req (struct xwds_soc *soc, xwid_t id)
	XWDS API：申请时钟

xwer_t	xwds_clk_rls (struct xwds_soc *soc, xwid_t id)
	XWDS API：释放时钟

xwer_t	xwds_clk_getfqcy (struct xwds_soc soc, xwid_t id, xwu32_t buf, xwsz_t *num)
	XWDS API：获取时钟频率

xwer_t	xwds_pwr_req (struct xwds_soc *soc, xwid_t id)
	XWDS API：申请电源

xwer_t	xwds_pwr_rls (struct xwds_soc *soc, xwid_t id)
	XWDS API：释放电源

xwer_t	xwds_pwr_getvltg (struct xwds_soc soc, xwid_t id, xwu32_t buf, xwsz_t *num)
	XWDS API：获取电源电压

xwer_t	xwds_dma_req (struct xwds_soc *soc, xwid_t ch)
	XWDS API：申请DMA的通道

xwer_t	xwds_dma_rls (struct xwds_soc *soc, xwid_t ch)
	XWDS API：释放DMA的通道

xwer_t	xwds_dma_cfg (struct xwds_soc soc, xwid_t ch, void cfg, xwds_dma_f cb, xwds_dma_cbarg_t arg)
	XWDS API：配置DMA的通道

xwer_t	xwds_dma_enable (struct xwds_soc *soc, xwid_t ch)
	XWDS API：打开DMA的通道

xwer_t	xwds_dma_disable (struct xwds_soc *soc, xwid_t ch)
	XWDS API：关闭DMA的通道

xwer_t	xwds_dma_start (struct xwds_soc *soc, xwid_t ch)
	XWDS API：启动DMA的通道

xwer_t	xwds_dma_stop (struct xwds_soc *soc, xwid_t ch)
	XWDS API：停止DMA的通道

#define	XWDS_DMA_CH(x) ((xwid_t)(x))
	XWDS DMA 通道

xwer_t	xwds_eirq_req (struct xwds_soc *soc, xwid_t port, xwsq_t pinmask, xwid_t eiid, xwsq_t eiflag, xwds_eirq_f isr, xwds_eirq_arg_t arg)
	XWDS API：申请外部中断

xwer_t	xwds_eirq_rls (struct xwds_soc *soc, xwid_t port, xwsq_t pinmask, xwid_t eiid)
	XWDS API：释放外部中断

#define	XWDS_EIRQ(x) ((xwid_t)x)
	XWDS External IRQ Number

enum	xwds_soc_ei_flag_em { XWDS_SOC_EIF_TM_RISING = ((xwbmp_t)1 << ( 0 )) , XWDS_SOC_EIF_TM_FALLING = ((xwbmp_t)1 << ( 1 )) , XWDS_SOC_EIF_TM_EITHER , XWDS_SOC_EIF_TM_LOW = ((xwbmp_t)1 << ( 2 )) , XWDS_SOC_EIF_TM_HIGH = ((xwbmp_t)1 << ( 3 )) , XWDS_SOC_EIF_TM_MASK , XWDS_SOC_EIF_WKUP = ((xwbmp_t)1 << ( 4 )) , XWDS_SOC_EIF_DMA = ((xwbmp_t)1 << ( 5 )) }
	外部中断标志更多...

xwer_t	xwds_gpio_req (struct xwds_soc *soc, xwid_t port, xwsq_t pinmask)
	XWDS API：申请SOC的GPIO

xwer_t	xwds_gpio_rls (struct xwds_soc *soc, xwid_t port, xwsq_t pinmask)
	XWDS API：释放SOC的GPIO

xwer_t	xwds_gpio_cfg (struct xwds_soc soc, xwid_t port, xwsq_t pinmask, void cfg)
	XWDS API：配置SOC的GPIO

xwer_t	xwds_gpio_set (struct xwds_soc *soc, xwid_t port, xwsq_t pinmask)
	XWDS API：将SOC的GPIO设置为高电平

xwer_t	xwds_gpio_reset (struct xwds_soc *soc, xwid_t port, xwsq_t pinmask)
	XWDS API：将SOC的GPIO设置为低电平

xwer_t	xwds_gpio_toggle (struct xwds_soc *soc, xwid_t port, xwsq_t pinmask)
	XWDS API：翻转SOC的GPIO电平

xwer_t	xwds_gpio_output (struct xwds_soc *soc, xwid_t port, xwsq_t pinmask, xwsq_t out)
	XWDS API：并行输出多个SOC的GPIO

xwer_t	xwds_gpio_input (struct xwds_soc soc, xwid_t port, xwsq_t pinmask, xwsq_t inbuf)
	XWDS API：并行读取多个SOC的GPIO

#define	XWDS_GPIO_PIN(n) (1U << (n))

#define	XWDS_GPIO_PIN_MASK(n) (XWDS_GPIO_PIN(n) - 1U)

enum	xwds_gpio_port_em { XWDS_GPIO_PORT_A = 0 , XWDS_GPIO_PORT_B , XWDS_GPIO_PORT_C , XWDS_GPIO_PORT_D , XWDS_GPIO_PORT_E , XWDS_GPIO_PORT_F , XWDS_GPIO_PORT_G , XWDS_GPIO_PORT_H , XWDS_GPIO_PORT_I , XWDS_GPIO_PORT_J , XWDS_GPIO_PORT_K , XWDS_GPIO_PORT_L , XWDS_GPIO_PORT_M , XWDS_GPIO_PORT_N , XWDS_GPIO_PORT_O , XWDS_GPIO_PORT_P , XWDS_GPIO_PORT_Q , XWDS_GPIO_PORT_R , XWDS_GPIO_PORT_S , XWDS_GPIO_PORT_T , XWDS_GPIO_PORT_U , XWDS_GPIO_PORT_V , XWDS_GPIO_PORT_W , XWDS_GPIO_PORT_X , XWDS_GPIO_PORT_Y , XWDS_GPIO_PORT_Z }
	XWDS GPIO Port 枚举更多...

enum	xwds_gpio_pin_em { XWDS_GPIO_PIN_0 = (1U << ( 0 )) , XWDS_GPIO_PIN_1 = (1U << ( 1 )) , XWDS_GPIO_PIN_2 = (1U << ( 2 )) , XWDS_GPIO_PIN_3 = (1U << ( 3 )) , XWDS_GPIO_PIN_4 = (1U << ( 4 )) , XWDS_GPIO_PIN_5 = (1U << ( 5 )) , XWDS_GPIO_PIN_6 = (1U << ( 6 )) , XWDS_GPIO_PIN_7 = (1U << ( 7 )) , XWDS_GPIO_PIN_8 = (1U << ( 8 )) , XWDS_GPIO_PIN_9 = (1U << ( 9 )) , XWDS_GPIO_PIN_10 = (1U << ( 10 )) , XWDS_GPIO_PIN_11 = (1U << ( 11 )) , XWDS_GPIO_PIN_12 = (1U << ( 12 )) , XWDS_GPIO_PIN_13 = (1U << ( 13 )) , XWDS_GPIO_PIN_14 = (1U << ( 14 )) , XWDS_GPIO_PIN_15 = (1U << ( 15 )) , XWDS_GPIO_PIN_16 = (1U << ( 16 )) , XWDS_GPIO_PIN_17 = (1U << ( 17 )) , XWDS_GPIO_PIN_18 = (1U << ( 18 )) , XWDS_GPIO_PIN_19 = (1U << ( 19 )) , XWDS_GPIO_PIN_20 = (1U << ( 20 )) , XWDS_GPIO_PIN_21 = (1U << ( 21 )) , XWDS_GPIO_PIN_22 = (1U << ( 22 )) , XWDS_GPIO_PIN_23 = (1U << ( 23 )) , XWDS_GPIO_PIN_24 = (1U << ( 24 )) , XWDS_GPIO_PIN_25 = (1U << ( 25 )) , XWDS_GPIO_PIN_26 = (1U << ( 26 )) , XWDS_GPIO_PIN_27 = (1U << ( 27 )) , XWDS_GPIO_PIN_28 = (1U << ( 28 )) , XWDS_GPIO_PIN_29 = (1U << ( 29 )) , XWDS_GPIO_PIN_30 = (1U << ( 30 )) , XWDS_GPIO_PIN_31 = (1U << ( 31 )) }
	XWDS GPIO Pin 枚举更多...

详细描述

宏定义说明

◆ __xwds_soc_dma_tbl_qualifier

#define __xwds_soc_dma_tbl_qualifier

在文件 chip.h 第 42 行定义.

◆ __xwds_soc_eirq_tbl_qualifier

#define __xwds_soc_eirq_tbl_qualifier

在文件 chip.h 第 36 行定义.

◆ XWDS_DMA_CH

#define XWDS_DMA_CH ( x ) ((xwid_t)(x))

XWDS DMA 通道

在文件 dma.h 第 36 行定义.

◆ XWDS_EIRQ

#define XWDS_EIRQ ( x ) ((xwid_t)x)

XWDS External IRQ Number

在文件 eirq.h 第 35 行定义.

◆ XWDS_GPIO_PIN

#define XWDS_GPIO_PIN ( n ) (1U << (n))

在文件 gpio.h 第 32 行定义.

◆ XWDS_GPIO_PIN_MASK

#define XWDS_GPIO_PIN_MASK ( n ) (XWDS_GPIO_PIN(n) - 1U)

在文件 gpio.h 第 33 行定义.

类型定义说明

◆ xwds_dma_cbarg_t

typedef void* xwds_dma_cbarg_t

DMA完成回调函数参数

在文件 chip.h 第 148 行定义.

◆ xwds_dma_f

typedef void(* xwds_dma_f) (struct xwds_soc *, xwid_t, xwu32_t, xwds_dma_cbarg_t)

DMA完成回调函数类型

在文件 chip.h 第 153 行定义.

◆ xwds_eirq_arg_t

typedef void* xwds_eirq_arg_t

外部中断函数参数

在文件 chip.h 第 138 行定义.

◆ xwds_eirq_f

typedef void(* xwds_eirq_f) (struct xwds_soc *, xwid_t, xwds_eirq_arg_t)

外部中断函数

在文件 chip.h 第 143 行定义.

枚举类型说明

◆ xwds_gpio_pin_em

enum xwds_gpio_pin_em

XWDS GPIO Pin 枚举

枚举值
XWDS_GPIO_PIN_0	Pin 0
XWDS_GPIO_PIN_1	Pin 1
XWDS_GPIO_PIN_2	Pin 2
XWDS_GPIO_PIN_3	Pin 3
XWDS_GPIO_PIN_4	Pin 4
XWDS_GPIO_PIN_5	Pin 5
XWDS_GPIO_PIN_6	Pin 6
XWDS_GPIO_PIN_7	Pin 7
XWDS_GPIO_PIN_8	Pin 8
XWDS_GPIO_PIN_9	Pin 9
XWDS_GPIO_PIN_10	Pin 10
XWDS_GPIO_PIN_11	Pin 11
XWDS_GPIO_PIN_12	Pin 12
XWDS_GPIO_PIN_13	Pin 13
XWDS_GPIO_PIN_14	Pin 14
XWDS_GPIO_PIN_15	Pin 15
XWDS_GPIO_PIN_16	Pin 16
XWDS_GPIO_PIN_17	Pin 17
XWDS_GPIO_PIN_18	Pin 18
XWDS_GPIO_PIN_19	Pin 19
XWDS_GPIO_PIN_20	Pin 20
XWDS_GPIO_PIN_21	Pin 21
XWDS_GPIO_PIN_22	Pin 22
XWDS_GPIO_PIN_23	Pin 23
XWDS_GPIO_PIN_24	Pin 24
XWDS_GPIO_PIN_25	Pin 25
XWDS_GPIO_PIN_26	Pin 26
XWDS_GPIO_PIN_27	Pin 27
XWDS_GPIO_PIN_28	Pin 28
XWDS_GPIO_PIN_29	Pin 29
XWDS_GPIO_PIN_30	Pin 30
XWDS_GPIO_PIN_31	Pin 31

在文件 gpio.h 第 70 行定义.

                      {
        XWDS_GPIO_PIN_0 = XWDS_GPIO_PIN(0), 
        XWDS_GPIO_PIN_1 = XWDS_GPIO_PIN(1), 
        XWDS_GPIO_PIN_2 = XWDS_GPIO_PIN(2), 
        XWDS_GPIO_PIN_3 = XWDS_GPIO_PIN(3), 
        XWDS_GPIO_PIN_4 = XWDS_GPIO_PIN(4), 
        XWDS_GPIO_PIN_5 = XWDS_GPIO_PIN(5), 
        XWDS_GPIO_PIN_6 = XWDS_GPIO_PIN(6), 
        XWDS_GPIO_PIN_7 = XWDS_GPIO_PIN(7), 
        XWDS_GPIO_PIN_8 = XWDS_GPIO_PIN(8), 
        XWDS_GPIO_PIN_9 = XWDS_GPIO_PIN(9), 
        XWDS_GPIO_PIN_10 = XWDS_GPIO_PIN(10), 
        XWDS_GPIO_PIN_11 = XWDS_GPIO_PIN(11), 
        XWDS_GPIO_PIN_12 = XWDS_GPIO_PIN(12), 
        XWDS_GPIO_PIN_13 = XWDS_GPIO_PIN(13), 
        XWDS_GPIO_PIN_14 = XWDS_GPIO_PIN(14), 
        XWDS_GPIO_PIN_15 = XWDS_GPIO_PIN(15), 
        XWDS_GPIO_PIN_16 = XWDS_GPIO_PIN(16), 
        XWDS_GPIO_PIN_17 = XWDS_GPIO_PIN(17), 
        XWDS_GPIO_PIN_18 = XWDS_GPIO_PIN(18), 
        XWDS_GPIO_PIN_19 = XWDS_GPIO_PIN(19), 
        XWDS_GPIO_PIN_20 = XWDS_GPIO_PIN(20), 
        XWDS_GPIO_PIN_21 = XWDS_GPIO_PIN(21), 
        XWDS_GPIO_PIN_22 = XWDS_GPIO_PIN(22), 
        XWDS_GPIO_PIN_23 = XWDS_GPIO_PIN(23), 
        XWDS_GPIO_PIN_24 = XWDS_GPIO_PIN(24), 
        XWDS_GPIO_PIN_25 = XWDS_GPIO_PIN(25), 
        XWDS_GPIO_PIN_26 = XWDS_GPIO_PIN(26), 
        XWDS_GPIO_PIN_27 = XWDS_GPIO_PIN(27), 
        XWDS_GPIO_PIN_28 = XWDS_GPIO_PIN(28), 
        XWDS_GPIO_PIN_29 = XWDS_GPIO_PIN(29), 
        XWDS_GPIO_PIN_30 = XWDS_GPIO_PIN(30), 
        XWDS_GPIO_PIN_31 = XWDS_GPIO_PIN(31), 
};

◆ xwds_gpio_port_em

enum xwds_gpio_port_em

XWDS GPIO Port 枚举

枚举值
XWDS_GPIO_PORT_A	GPIO A
XWDS_GPIO_PORT_B	GPIO B
XWDS_GPIO_PORT_C	GPIO C
XWDS_GPIO_PORT_D	GPIO D
XWDS_GPIO_PORT_E	GPIO E
XWDS_GPIO_PORT_F	GPIO F
XWDS_GPIO_PORT_G	GPIO G
XWDS_GPIO_PORT_H	GPIO H
XWDS_GPIO_PORT_I	GPIO I
XWDS_GPIO_PORT_J	GPIO J
XWDS_GPIO_PORT_K	GPIO K
XWDS_GPIO_PORT_L	GPIO L
XWDS_GPIO_PORT_M	GPIO M
XWDS_GPIO_PORT_N	GPIO N
XWDS_GPIO_PORT_O	GPIO O
XWDS_GPIO_PORT_P	GPIO P
XWDS_GPIO_PORT_Q	GPIO Q
XWDS_GPIO_PORT_R	GPIO R
XWDS_GPIO_PORT_S	GPIO S
XWDS_GPIO_PORT_T	GPIO T
XWDS_GPIO_PORT_U	GPIO U
XWDS_GPIO_PORT_V	GPIO V
XWDS_GPIO_PORT_W	GPIO W
XWDS_GPIO_PORT_X	GPIO X
XWDS_GPIO_PORT_Y	GPIO Y
XWDS_GPIO_PORT_Z	GPIO Z

在文件 gpio.h 第 38 行定义.

                       {
        XWDS_GPIO_PORT_A = 0, 
        XWDS_GPIO_PORT_B, 
        XWDS_GPIO_PORT_C, 
        XWDS_GPIO_PORT_D, 
        XWDS_GPIO_PORT_E, 
        XWDS_GPIO_PORT_F, 
        XWDS_GPIO_PORT_G, 
        XWDS_GPIO_PORT_H, 
        XWDS_GPIO_PORT_I, 
        XWDS_GPIO_PORT_J, 
        XWDS_GPIO_PORT_K, 
        XWDS_GPIO_PORT_L, 
        XWDS_GPIO_PORT_M, 
        XWDS_GPIO_PORT_N, 
        XWDS_GPIO_PORT_O, 
        XWDS_GPIO_PORT_P, 
        XWDS_GPIO_PORT_Q, 
        XWDS_GPIO_PORT_R, 
        XWDS_GPIO_PORT_S, 
        XWDS_GPIO_PORT_T, 
        XWDS_GPIO_PORT_U, 
        XWDS_GPIO_PORT_V, 
        XWDS_GPIO_PORT_W, 
        XWDS_GPIO_PORT_X, 
        XWDS_GPIO_PORT_Y, 
        XWDS_GPIO_PORT_Z, 
};

◆ xwds_soc_ei_flag_em

enum xwds_soc_ei_flag_em

外部中断标志

枚举值
XWDS_SOC_EIF_TM_RISING	上升沿触发
XWDS_SOC_EIF_TM_FALLING	下降沿触发
XWDS_SOC_EIF_TM_EITHER	任意边沿触发
XWDS_SOC_EIF_TM_LOW	低电平触发
XWDS_SOC_EIF_TM_HIGH	高电平触发
XWDS_SOC_EIF_TM_MASK
XWDS_SOC_EIF_WKUP	唤醒
XWDS_SOC_EIF_DMA	触发DMA

在文件 eirq.h 第 40 行定义.

                         {
        XWDS_SOC_EIF_TM_RISING = XWBOP_BIT(0), 
        XWDS_SOC_EIF_TM_FALLING = XWBOP_BIT(1), 
        XWDS_SOC_EIF_TM_EITHER = (XWDS_SOC_EIF_TM_RISING |
                                  XWDS_SOC_EIF_TM_FALLING), 
        XWDS_SOC_EIF_TM_LOW = XWBOP_BIT(2), 
        XWDS_SOC_EIF_TM_HIGH = XWBOP_BIT(3), 
        XWDS_SOC_EIF_TM_MASK = (XWDS_SOC_EIF_TM_RISING | XWDS_SOC_EIF_TM_FALLING |
                                XWDS_SOC_EIF_TM_LOW | XWDS_SOC_EIF_TM_HIGH),
        XWDS_SOC_EIF_WKUP = XWBOP_BIT(4), 
        XWDS_SOC_EIF_DMA = XWBOP_BIT(5), 
};

函数说明

◆ xwds_clk_getfqcy()

xwer_t xwds_clk_getfqcy	(	struct xwds_soc *	soc,
		xwid_t	id,
		xwu32_t *	buf,
		xwsz_t *	num
	)

XWDS API：获取时钟频率

参数

[in]	soc	SOC对象指针
[in]	id	时钟ID
[out]	buf	返回时钟频率的缓冲区的指针
[in,out]	num	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示缓冲区数组的数量 (O) 作为输出时，返回实际的频率数据的数量

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	时钟ID错误
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 clock.c 第 83 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((id < soc->clk.num), "out-of-range", -ERANGE);
        XWDS_VALIDATE(buf, "nullptr", -EFAULT);
        XWDS_VALIDATE(num, "nullptr", -EFAULT);
 
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
 
        drv = xwds_cast(struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->clk_getfqcy)) {
                rc = drv->clk_getfqcy(soc, id, buf, num);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_getfqcy;
        }
 
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_getfqcy:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_clk_req()

xwer_t xwds_clk_req	(	struct xwds_soc *	soc,
		xwid_t	id
	)

XWDS API：申请时钟

参数

[in]	soc	SOC对象指针
[in]	id	时钟ID

返回: 错误码

返回值

XWOK	没有错误
-ERANGE	时钟ID错误
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 clock.c 第 26 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((id < soc->clk.num), "out-of-range", -ERANGE);
 
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
 
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->clk_req)) {
                rc = drv->clk_req(soc, id);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_clk_req;
        }
        return XWOK;
 
err_drv_clk_req:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_clk_rls()

xwer_t xwds_clk_rls	(	struct xwds_soc *	soc,
		xwid_t	id
	)

XWDS API：释放时钟

参数

[in]	soc	SOC对象指针
[in]	id	时钟ID

返回: 错误码

返回值

XWOK	没有错误
-ERANGE	时钟ID错误
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 clock.c 第 57 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((id < soc->clk.num), "out-of-range", -ERANGE);
 
        drv = xwds_cast(struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->clk_rls)) {
                rc = drv->clk_rls(soc, id);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_clk_rls;
        }
 
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_clk_rls:
        return rc;
}

函数调用图:

◆ xwds_dma_cfg()

xwer_t xwds_dma_cfg	(	struct xwds_soc *	soc,
		xwid_t	ch,
		void *	cfg,
		xwds_dma_f	cb,
		xwds_dma_cbarg_t	arg
	)

XWDS API：配置DMA的通道

参数

[in]	soc	SOC对象指针
[in]	ch	DMA通道
[in]	cfg	SOC DMA通道配置
[in]	cb	传输结束回调函数
[in]	cfg	回调函数参数

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	无效的DMA通道
-EPERM	DMA通道未被使用

注解

上下文：中断、中断底半部、线程

<No error

在文件 dma.c 第 91 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE(((xwid_t)ch < soc->dma.ch_num), "out-of-range", -ERANGE);
 
        if (!xwbmpaop_t1i(soc->dma.chstatus, ch)) {
                rc = -EPERM;
                goto err_notreq;
        }
#if defined(XWCDCFG_ds_SOC_DMA_ROCBT) && (1 == XWCDCFG_ds_SOC_DMA_ROCBT)
        XWOS_UNUSED(cb);
        XWOS_UNUSED(arg);
#else
        if (soc->dma.chcbs) {
                soc->dma.chcbs[ch] = cb;
        }
        if (soc->dma.chcbargs) {
                soc->dma.chcbargs[ch] = arg;
        }
#endif
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->dma_cfg)) {
                rc = drv->dma_cfg(soc, ch, cfg);
                if (rc < 0) {
                        goto err_drv_dma_cfg;
                }
        }
        return XWOK;
 
err_drv_dma_cfg:
#if !defined(XWCDCFG_ds_SOC_DMA_ROCBT) || (1 != XWCDCFG_ds_SOC_DMA_ROCBT)
        if (soc->dma.chcbs) {
                soc->dma.chcbs[ch] = NULL;
        }
        if (soc->dma.chcbargs) {
                soc->dma.chcbargs[ch] = NULL;
        }
#endif
err_notreq:
        return rc;
}

函数调用图:

◆ xwds_dma_disable()

xwer_t xwds_dma_disable	(	struct xwds_soc *	soc,
		xwid_t	ch
	)

XWDS API：关闭DMA的通道

参数

[in]	soc	SOC对象指针
[in]	ch	DMA通道

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	无效的DMA通道
-EPERM	DMA通道未被使用

注解

上下文：中断、中断底半部、线程

<No error

在文件 dma.c 第 165 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE(((xwid_t)ch < soc->dma.ch_num), "out-of-range", -ERANGE);
 
        if (!xwbmpaop_t1i(soc->dma.chstatus, ch)) {
                rc = -EPERM;
                goto err_notreq;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->dma_disable)) {
                rc = drv->dma_disable(soc, ch);
                if (rc < 0) {
                        goto err_drv_dma_disable;
                }
        }
        return XWOK;
 
err_drv_dma_disable:
err_notreq:
        return rc;
}

函数调用图:

◆ xwds_dma_enable()

xwer_t xwds_dma_enable	(	struct xwds_soc *	soc,
		xwid_t	ch
	)

XWDS API：打开DMA的通道

参数

[in]	soc	SOC对象指针
[in]	ch	DMA通道

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	无效的DMA通道
-EPERM	DMA通道未被使用

注解

上下文：中断、中断底半部、线程

<No error

在文件 dma.c 第 138 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE(((xwid_t)ch < soc->dma.ch_num), "out-of-range", -ERANGE);
 
        if (!xwbmpaop_t1i(soc->dma.chstatus, ch)) {
                rc = -EPERM;
                goto err_notreq;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->dma_enable)) {
                rc = drv->dma_enable(soc, ch);
                if (rc < 0) {
                        goto err_drv_dma_enable;
                }
        }
        return XWOK;
 
err_drv_dma_enable:
err_notreq:
        return rc;
}

函数调用图:

◆ xwds_dma_req()

xwer_t xwds_dma_req	(	struct xwds_soc *	soc,
		xwid_t	ch
	)

XWDS API：申请DMA的通道

参数

[in]	soc	SOC对象指针
[in]	ch	DMA通道

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	无效的DMA通道
-EBUSY	DMA通道繁忙

注解

上下文：中断、中断底半部、线程

<No error

在文件 dma.c 第 27 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE(((xwid_t)ch < soc->dma.ch_num), "out-of-range", -ERANGE);
 
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
        rc = xwbmpaop_t0i_then_s1i(soc->dma.chstatus, ch);
        if (rc < 0) {
                rc = -EBUSY;
                goto err_busy;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->dma_req)) {
                rc = drv->dma_req(soc, ch);
                if (rc < 0) {
                        goto err_drv_dma_req;
                }
        }
        return XWOK;
 
err_drv_dma_req:
        xwbmpaop_s1i(soc->dma.chstatus, ch);
err_busy:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_dma_rls()

xwer_t xwds_dma_rls	(	struct xwds_soc *	soc,
		xwid_t	ch
	)

XWDS API：释放DMA的通道

参数

[in]	soc	SOC对象指针
[in]	ch	DMA通道

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	无效的DMA通道
-EPERM	DMA通道未被使用

注解

上下文：中断、中断底半部、线程

<No error

在文件 dma.c 第 62 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE(((xwid_t)ch < soc->dma.ch_num), "out-of-range", -ERANGE);
 
        if (!xwbmpaop_t1i(soc->dma.chstatus, ch)) {
                rc = -EPERM;
                goto err_notreq;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->dma_rls)) {
                rc = drv->dma_rls(soc, ch);
                if (rc < 0) {
                        goto err_drv_dma_rls;
                }
        }
        xwbmpaop_c0i(soc->dma.chstatus, ch);
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_dma_rls:
err_notreq:
        return rc;
}

函数调用图:

◆ xwds_dma_start()

xwer_t xwds_dma_start	(	struct xwds_soc *	soc,
		xwid_t	ch
	)

XWDS API：启动DMA的通道

参数

[in]	soc	SOC对象指针
[in]	ch	DMA通道

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	无效的DMA通道
-EPERM	DMA通道未被使用

注解

上下文：中断、中断底半部、线程

<No error

在文件 dma.c 第 192 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE(((xwid_t)ch < soc->dma.ch_num), "out-of-range", -ERANGE);
 
        if (!xwbmpaop_t1i(soc->dma.chstatus, ch)) {
                rc = -EPERM;
                goto err_notreq;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->dma_start)) {
                rc = drv->dma_start(soc, ch);
                if (rc < 0) {
                        goto err_drv_dma_start;
                }
        }
        return XWOK;
 
err_drv_dma_start:
err_notreq:
        return rc;
}

函数调用图:

◆ xwds_dma_stop()

xwer_t xwds_dma_stop	(	struct xwds_soc *	soc,
		xwid_t	ch
	)

XWDS API：停止DMA的通道

参数

[in]	soc	SOC对象指针
[in]	ch	DMA通道

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	无效的DMA通道
-EPERM	DMA通道未被使用

注解

上下文：中断、中断底半部、线程

<No error

在文件 dma.c 第 219 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE(((xwid_t)ch < soc->dma.ch_num), "out-of-range", -ERANGE);
 
        if (!xwbmpaop_t1i(soc->dma.chstatus, ch)) {
                rc = -EPERM;
                goto err_notreq;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->dma_stop)) {
                rc = drv->dma_stop(soc, ch);
                if (rc < 0) {
                        goto err_drv_dma_stop;
                }
        }
        return XWOK;
 
err_drv_dma_stop:
err_notreq:
        return rc;
}

函数调用图:

◆ xwds_eirq_req()

xwer_t xwds_eirq_req	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask,
		xwid_t	eiid,
		xwsq_t	eiflag,
		xwds_eirq_f	isr,
		xwds_eirq_arg_t	arg
	)

XWDS API：申请外部中断

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口
[in]	pinmask	GPIO PIN
[in]	eiid	外部中断ID
[in]	eiflag	触发标志
[in]	isr	中断响应函数
[in]	arg	中断响应函数参数

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	外部中断ID错误

注解

上下文：中断、中断底半部、线程

<No error

在文件 eirq.c 第 26 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((eiid < soc->eirq.num), "out-of-range", -ERANGE);
 
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
 
#if defined(XWCDCFG_ds_SOC_EIRQ_ROISRT) && (1 == XWCDCFG_ds_SOC_EIRQ_ROISRT)
        XWOS_UNUSED(isr);
        XWOS_UNUSED(arg);
        if (NULL == soc->eirq.isrs[eiid]) {
                rc = -EPERM;
                goto err_perm;
        }
#else
        if (soc->eirq.isrs[eiid]) {
                rc = -EBUSY;
                goto err_perm;
        }
        soc->eirq.isrs[eiid] = isr ? isr : (xwds_eirq_f)err_ptr(-EBUSY);
        soc->eirq.isrargs[eiid] = arg;
#endif
 
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->eirq_req)) {
                rc = drv->eirq_req(soc, port, pinmask, eiid, eiflag);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_eirq_req;
        }
        return XWOK;
 
err_drv_eirq_req:
#if !defined(XWCDCFG_ds_SOC_EIRQ_ROISRT) || (1 != XWCDCFG_ds_SOC_EIRQ_ROISRT)
        soc->eirq.isrs[eiid] = NULL;
        soc->eirq.isrargs[eiid] = NULL;
#endif
err_perm:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_eirq_rls()

xwer_t xwds_eirq_rls	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask,
		xwid_t	eiid
	)

XWDS API：释放外部中断

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口
[in]	pinmask	GPIO PIN
[in]	eiid	外部中断ID

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	外部中断ID错误

注解

上下文：中断、中断底半部、线程

<No error

在文件 eirq.c 第 80 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((eiid < soc->eirq.num), "out-of-range", -ERANGE);
 
        if (NULL == soc->eirq.isrs[eiid]) {
                rc = -EPERM;
                goto err_notinused;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->eirq_rls)) {
                rc = drv->eirq_rls(soc, port, pinmask, eiid);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_rlsei;
        }
#if !defined(XWCDCFG_ds_SOC_EIRQ_ROISRT) || (1 != XWCDCFG_ds_SOC_EIRQ_ROISRT)
        soc->eirq.isrs[eiid] = NULL;
        soc->eirq.isrargs[eiid] = NULL;
#endif
 
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_rlsei:
err_notinused:
        return rc;
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_gpio_cfg()

xwer_t xwds_gpio_cfg	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask,
		void *	cfg
	)

XWDS API：配置SOC的GPIO

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口，取值 xwds_gpio_port_em 中的一项
[in]	pinmask	引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算
[in]	cfg	GPIO配置，取值依据不同SOC

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	GPIO PORT错误
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 gpio.c 第 96 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((port < soc->gpio.port_num), "out-of-range", -ERANGE);
        XWDS_VALIDATE(cfg, "nullptr", -EFAULT);
 
        pinmask &= XWDS_GPIO_PIN_MASK(soc->gpio.pin_num);
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
               goto err_soc_grab;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->gpio_cfg)) {
                rc = drv->gpio_cfg(soc, port, pinmask, cfg);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_gpio_cfg;
        }
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_gpio_cfg:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_gpio_input()

xwer_t xwds_gpio_input	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask,
		xwsq_t *	inbuf
	)

XWDS API：并行读取多个SOC的GPIO

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口，取值 xwds_gpio_port_em 中的一项
[in]	pinmask	引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算
[out]	inbuf	输入缓冲区

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	GPIO PORT错误
-EPERM	GPIO PIN未被申请
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 gpio.c 第 289 行定义.

{
        const struct xwds_soc_driver * drv;
        xwsq_t pinsts;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((port < soc->gpio.port_num), "out-of-range", -ERANGE);
 
        pinmask &= XWDS_GPIO_PIN_MASK(soc->gpio.pin_num);
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
        pinsts = xwaop_load(xwsq_t, &soc->gpio.pins[port], xwaop_mo_relaxed);
        if (pinmask & (~pinsts)) {
                rc = -EPERM;
                goto err_pinsts;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->gpio_input)) {
                rc = drv->gpio_input(soc, port, pinmask, inbuf);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_in;
        }
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_in:
err_pinsts:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_gpio_output()

xwer_t xwds_gpio_output	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask,
		xwsq_t	out
	)

XWDS API：并行输出多个SOC的GPIO

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口，取值 xwds_gpio_port_em 中的一项
[in]	pinmask	引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算
[in]	out	输出值，引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算，只有被pinmask掩码覆盖的部分有效，未覆盖的pin输出不会发生改变。

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	GPIO PORT错误
-EPERM	GPIO PIN未被申请
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 gpio.c 第 248 行定义.

{
        const struct xwds_soc_driver * drv;
        xwsq_t pinsts;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((port < soc->gpio.port_num), "out-of-range", -ERANGE);
 
        pinmask &= XWDS_GPIO_PIN_MASK(soc->gpio.pin_num);
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
        pinsts = xwaop_load(xwsq_t, &soc->gpio.pins[port], xwaop_mo_relaxed);
        if (pinmask & (~pinsts)) {
                rc = -EPERM;
                goto err_pinsts;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->gpio_output)) {
                rc = drv->gpio_output(soc, port, pinmask, out);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_out;
        }
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_out:
err_pinsts:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_gpio_req()

xwer_t xwds_gpio_req	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask
	)

XWDS API：申请SOC的GPIO

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口，取值 xwds_gpio_port_em 中的一项
[in]	pinmask	引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	GPIO PORT错误
-EBUSY	GPIO PIN已被使用

注解

上下文：中断、中断底半部、线程

<No error

在文件 gpio.c 第 27 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((port < soc->gpio.port_num), "out-of-range", -ERANGE);
 
        pinmask &= XWDS_GPIO_PIN_MASK(soc->gpio.pin_num);
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
        rc = xwaop_t0ma_then_s1m(xwsq_t, &soc->gpio.pins[port], pinmask, NULL, NULL);
        if (rc < 0) {
                rc = -EBUSY;
                goto err_set_pin;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->gpio_req)) {
                rc = drv->gpio_req(soc, port, pinmask);
                if (rc < 0) {
                        goto err_drv_gpio_req;
                }
        }
        return XWOK;
 
err_drv_gpio_req:
        xwaop_c0m(xwsq_t, &soc->gpio.pins[port], pinmask, NULL, NULL);
err_set_pin:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_gpio_reset()

xwer_t xwds_gpio_reset	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask
	)

XWDS API：将SOC的GPIO设置为低电平

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口，取值 xwds_gpio_port_em 中的一项
[in]	pinmask	引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	GPIO PORT错误
-EPERM	GPIO PIN未被申请
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 gpio.c 第 170 行定义.

{
        const struct xwds_soc_driver * drv;
        xwsq_t pinsts;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((port < soc->gpio.port_num), "out-of-range", -ERANGE);
 
        pinmask &= XWDS_GPIO_PIN_MASK(soc->gpio.pin_num);
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
        pinsts = xwaop_load(xwsq_t, &soc->gpio.pins[port], xwaop_mo_relaxed);
        if (pinmask & (~pinsts)) {
                rc = -EPERM;
                goto err_pinsts;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->gpio_reset)) {
                rc = drv->gpio_reset(soc, port, pinmask);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_reset;
        }
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_reset:
err_pinsts:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_gpio_rls()

xwer_t xwds_gpio_rls	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask
	)

XWDS API：释放SOC的GPIO

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口，取值 xwds_gpio_port_em 中的一项
[in]	pinmask	引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	GPIO PORT错误
-EPERM	GPIO PIN未被申请

注解

上下文：中断、中断底半部、线程

<No error

在文件 gpio.c 第 63 行定义.

{
        const struct xwds_soc_driver * drv;
        xwsq_t pinsts;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((port < soc->gpio.port_num), "out-of-range", -ERANGE);
 
        pinmask &= XWDS_GPIO_PIN_MASK(soc->gpio.pin_num);
        pinsts = xwaop_load(xwsq_t, &soc->gpio.pins[port], xwaop_mo_relaxed);
        if (pinmask & (~pinsts)) {
                rc = -EPERM;
                goto err_pinsts;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->gpio_rls)) {
                rc = drv->gpio_rls(soc, port, pinmask);
                if (rc < 0) {
                        goto err_drv_gpio_rls;
                }
        }
        xwaop_c0m(xwsq_t, &soc->gpio.pins[port], pinmask, NULL, NULL);
 
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_gpio_rls:
err_pinsts:
        return rc;
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_gpio_set()

xwer_t xwds_gpio_set	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask
	)

XWDS API：将SOC的GPIO设置为高电平

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口，取值 xwds_gpio_port_em 中的一项
[in]	pinmask	引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	GPIO PORT错误
-EPERM	GPIO PIN未被申请
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 gpio.c 第 131 行定义.

{
        const struct xwds_soc_driver * drv;
        xwsq_t pinsts;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((port < soc->gpio.port_num), "out-of-range", -ERANGE);
 
        pinmask &= XWDS_GPIO_PIN_MASK(soc->gpio.pin_num);
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
        pinsts = xwaop_load(xwsq_t, &soc->gpio.pins[port], xwaop_mo_relaxed);
        if (pinmask & (~pinsts)) {
                rc = -EPERM;
                goto err_pinsts;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->gpio_set)) {
                rc = drv->gpio_set(soc, port, pinmask);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_set;
        }
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_set:
err_pinsts:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_gpio_toggle()

xwer_t xwds_gpio_toggle	(	struct xwds_soc *	soc,
		xwid_t	port,
		xwsq_t	pinmask
	)

XWDS API：翻转SOC的GPIO电平

参数

[in]	soc	SOC对象指针
[in]	port	GPIO端口，取值 xwds_gpio_port_em 中的一项
[in]	pinmask	引脚的掩码，取值 xwds_gpio_pin_em 中的任意项的或运算

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	GPIO PORT错误
-EPERM	GPIO PIN未被申请
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 gpio.c 第 209 行定义.

{
        const struct xwds_soc_driver * drv;
        xwsq_t pinsts;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((port < soc->gpio.port_num), "out-of-range", -ERANGE);
 
        pinmask &= XWDS_GPIO_PIN_MASK(soc->gpio.pin_num);
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
        pinsts = xwaop_load(xwsq_t, &soc->gpio.pins[port], xwaop_mo_relaxed);
        if (pinmask & (~pinsts)) {
                rc = -EPERM;
                goto err_pinsts;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->gpio_toggle)) {
                rc = drv->gpio_toggle(soc, port, pinmask);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_toggle;
        }
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_toggle:
err_pinsts:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_pwr_getvltg()

xwer_t xwds_pwr_getvltg	(	struct xwds_soc *	soc,
		xwid_t	id,
		xwu32_t *	buf,
		xwsz_t *	num
	)

XWDS API：获取电源电压

参数

[in]	soc	SOC对象指针
[in]	id	电源ID
[out]	buf	返回电源电压的缓冲区的指针
[in,out]	num	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示缓冲区数组的数量 (O) 作为输出时，返回实际的电压数据的数量

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	电源ID错误
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 power.c 第 83 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((id < soc->pwr.num), "out-of-range", -ERANGE);
        XWDS_VALIDATE(buf, "nullptr", -EFAULT);
        XWDS_VALIDATE(num, "nullptr", -EFAULT);
 
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
 
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->pwr_getvltg)) {
                rc = drv->pwr_getvltg(soc, id, buf, num);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_getvltg;
        }
 
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_getvltg:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_pwr_req()

xwer_t xwds_pwr_req	(	struct xwds_soc *	soc,
		xwid_t	id
	)

XWDS API：申请电源

参数

[in]	soc	SOC对象指针
[in]	id	电源ID

返回: 错误码

返回值

XWOK	没有错误
-ERANGE	电源ID错误
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 power.c 第 26 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((id < soc->pwr.num), "out-of-range", -ERANGE);
 
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
 
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->pwr_req)) {
                rc = drv->pwr_req(soc, id);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_pwr_req;
        }
        return XWOK;
 
err_drv_pwr_req:
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_pwr_rls()

xwer_t xwds_pwr_rls	(	struct xwds_soc *	soc,
		xwid_t	id
	)

XWDS API：释放电源

参数

[in]	soc	SOC对象指针
[in]	id	电源ID

返回: 错误码

返回值

XWOK	没有错误
-ERANGE	电源ID错误
-ENOSYS	不支持的API

注解

上下文：中断、中断底半部、线程

<No error

在文件 power.c 第 57 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE((id < soc->pwr.num), "out-of-range", -ERANGE);
 
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->pwr_rls)) {
                rc = drv->pwr_rls(soc, id);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_pwr_rls;
        }
 
        xwds_soc_put(soc);
        return XWOK;
 
err_drv_pwr_rls:
        return rc;
}

函数调用图:

◆ xwds_soc_construct()

void xwds_soc_construct ( struct xwds_soc * soc )

XWDS API：SOC构造函数

参数

[in] soc SOC对象指针

在文件 chip.c 第 58 行定义.

{
        xwds_device_construct(&soc->dev);
        soc->dev.vop = &xwds_soc_vop;
}

函数调用图:

◆ xwds_soc_destruct()

void xwds_soc_destruct ( struct xwds_soc * soc )

XWDS API：SOC对象的析构函数

参数

[in] soc SOC对象指针

在文件 chip.c 第 65 行定义.

{
        xwds_device_destruct(&soc->dev);
}

函数调用图:

◆ xwds_soc_get_reset_reason()

xwer_t xwds_soc_get_reset_reason	(	struct xwds_soc *	soc,
		xwu64_t *	reason
	)

XWDS API：获取复位原因

参数

[in]	soc	SOC对象指针
[out]	reason	返回复位原因的缓冲区

在文件 chip.c 第 83 行定义.

{
        const struct xwds_soc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(soc, "nullptr", -EFAULT);
        XWDS_VALIDATE(reason, "nullptr", -EFAULT);
 
        rc = xwds_soc_grab(soc);
        if (rc < 0) {
                goto err_soc_grab;
        }
        drv = xwds_cast(const struct xwds_soc_driver *, soc->dev.drv);
        if ((drv) && (drv->get_reset_reason)) {
                rc = drv->get_reset_reason(soc, reason);
        } else {
                rc = -ENOSYS;
        }
        xwds_soc_put(soc);
err_soc_grab:
        return rc;
}

函数调用图:

◆ xwds_soc_grab()

xwer_t xwds_soc_grab ( struct xwds_soc * soc )

XWDS API：增加对象的引用计数

参数

[in] soc SOC对象指针

在文件 chip.c 第 71 行定义.

{
        return xwds_device_grab(&soc->dev);
}

函数调用图:

这是这个函数的调用关系图:

◆ xwds_soc_put()

xwer_t xwds_soc_put ( struct xwds_soc * soc )

XWDS API：减少对象的引用计数

参数

[in] soc SOC对象指针

在文件 chip.c 第 77 行定义.

{
        return xwds_device_put(&soc->dev);
}

函数调用图:

这是这个函数的调用关系图:

结构体

宏定义

类型定义

函数

详细描述

宏定义说明

◆ __xwds_soc_dma_tbl_qualifier

◆ __xwds_soc_eirq_tbl_qualifier

◆ XWDS_DMA_CH

◆ XWDS_EIRQ

◆ XWDS_GPIO_PIN

◆ XWDS_GPIO_PIN_MASK

类型定义说明

◆ xwds_dma_cbarg_t

◆ xwds_dma_f

◆ xwds_eirq_arg_t

◆ xwds_eirq_f

枚举类型说明

◆ xwds_gpio_pin_em

◆ xwds_gpio_port_em

◆ xwds_soc_ei_flag_em

函数说明

◆ xwds_clk_getfqcy()

◆ xwds_clk_req()

◆ xwds_clk_rls()

◆ xwds_dma_cfg()

◆ xwds_dma_disable()

◆ xwds_dma_enable()

◆ xwds_dma_req()

◆ xwds_dma_rls()

◆ xwds_dma_start()

◆ xwds_dma_stop()

◆ xwds_eirq_req()

◆ xwds_eirq_rls()

◆ xwds_gpio_cfg()

◆ xwds_gpio_input()

◆ xwds_gpio_output()

◆ xwds_gpio_req()

◆ xwds_gpio_reset()

◆ xwds_gpio_rls()

◆ xwds_gpio_set()

◆ xwds_gpio_toggle()

◆ xwds_pwr_getvltg()

◆ xwds_pwr_req()

◆ xwds_pwr_rls()

◆ xwds_soc_construct()

◆ xwds_soc_destruct()

◆ xwds_soc_get_reset_reason()

◆ xwds_soc_grab()

◆ xwds_soc_put()