xuos
/
xuos-web
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modify web about lian framework

This commit is contained in:
gumj 2021-05-06 11:29:45 +08:00
parent 02566a1259
commit 68d28c4e19
2 changed files with 79 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/doc/framework/imagesrc/lian.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 46 KiB

176
docs/doc/framework/lian.md
View File

@ -3,167 +3,149 @@
多数嵌入式操作系统，应具备传输多种网络协议数据的能力，但是网络协议种类繁多，为每种协议都开放单独的接口，势必会增加操作系统使用者的开发负担，亦不利于嵌入式操作系统的普及与推广。 多数嵌入式操作系统，应具备传输多种网络协议数据的能力，但是网络协议种类繁多，为每种协议都开放单独的接口，势必会增加操作系统使用者的开发负担，亦不利于嵌入式操作系统的普及与推广。
XiUOS网络框架采用以网络适配器为中心的抽象方式，发送与接收数据时，只需要像Linux socket网络通信一样，仅关注发送与接收的数据，而不用把重点放在所使用的具体协议上。这种抽象方式有效屏蔽了种类繁多的网络协议细节，对外提供统一的网络接口，简化了基于嵌入式操作系统的网络开发。网络框架对各类协议的网络设备进行了抽象： XiUOS网络框架采用以网络适配器为中心的抽象方式，发送与接收数据时，只需要像Linux socket网络通信一样，仅关注发送与接收的数据，而不用把重点放在所使用的具体协议上。这种抽象方式有效屏蔽了种类繁多的网络协议细节，对外提供统一的网络接口，简化了基于嵌入式操作系统的网络开发。网络框架对各类协议的网络设备进行了抽象：
* 一个网络协议设备，被抽象为一个xs_Adapter * 一个网络协议设备，被抽象为一个Adapter
xs_Adapter可以被设计为采用类似面向对象的方法，针对不同的网络协议，扩展其数据成员与接口，从而为种类繁多的网络协议实现统一的管理架构。在网络应用开发的过程中，只需要使用对应网络协议的xs_Adapter实例，而无需关心网络协议的硬件细节，从而实现了网络数据收发功能与底层硬件的解耦。 Adapter可以被设计为采用类似面向对象的方法，针对不同的网络协议，扩展其数据成员与接口，从而为种类繁多的网络协议实现统一的管理架构。在网络应用开发的过程中，只需要使用对应网络协议的Adapter实例，而无需关心网络协议的硬件细节，从而实现了网络数据收发功能与底层硬件的解耦。
<center> <center>
![LIAN IMAGE](./imagesrc/lian.png) <img src="./imagesrc/lian.png" width="110%"/>
</center> </center>
## 1. XiUOS网络框架关键数据结构定义和解析 ## 1. XiUOS网络框架关键数据结构定义和解析
* struct xs_Adapter结构 * struct Adapter结构
```c ```c
struct xs_Adapter struct Adapter
{ {
    const char name[XS_NAME_MAX];  /* name of the adapter instance */ enum AdapterType type; /* type of adapter, such as lora adapter */
    enum xs_AdapterType type;       /* type of adapter, such as lora adapter */ enum NetRoleType net_role_type;
    xs_AdapterInfo info;    /* adapter model info, such as vendor name and model name */ enum MeshType mesh_type;
    struct xs_AdapterOps ops;  /* socket-like APIs for data transferring */ struct AdapterDone done; /* socket-like APIs for data transferring */
    struct xs_AdapterInterface interface;  /* physical interface for transferring data */ struct SysDoubleLinklistNode link; /* link list node */
    struct XS_DOUBLE_LINKLIST_NODE link;  /* link list node */
}; };
``` ```
name成员是一个可读的名字，用于唯一标识一个xs_Adapter结构。type成员表示该xs_Adapter所使用的网络协议，用一个枚举变量表示： AdapterType用于表示网络类型，比如WiFi，Ethernet。
```c ```c
enum xs_AdapterType { enum AdapterType {
    XS_ADAPTER_LORA = 0,  /* Lora */     ADAPTER_LORA = 0,  /* Lora */
    XS_ADAPTER_4G ,       /* 4G */     ADAPTER_4G ,       /* 4G */
    /* ...... */     /* ...... */
    XS_ADAPTER_WIFI ,     /* Wifi */     ADAPTER_WIFI ,     /* Wifi */
}; };
``` ```
info成员包含此网络设备的基础信息，如厂家名vendor与型号product_model。 NetRoleType表示Adapter作为什么身份参与网络构建。
```c
enum NetRoleType{
ROLE_TYPE_SLAVE = 1,
ROLE_TYPE_MASTER,
ROLE_TYPE_NONE,
};
```
MeshType成员表示该mesh_type是否使用自组网络协议，用一个枚举变量表示。
```c
enum MeshType{
NET_P2P = 0,
NET_ADHOC_SINGLE_GROUP,
NET_ADHOC_MULTI_GROUP,
};
```
AdapterDone成员包含统一的、类似文件系统的API，用于对网络适配器进行实际的数据读写。在使用一个网络适配器前后需要打开（NetAiitOpen）/关闭（NetAiitClose）该网络适配器，NetAiitSend、NetAiitReceive分别用与从网络适配器接收数据与向网络适配器发送数据，NetAiitIoctl用于配置Adapter属性：
```c ```c
struct xs_AdapterInfo{ struct AdapterDone {
    const char *vendor; void (*NetAiitClose)(struct Adapter *padapter);
    const char *product_model; int (*NetAiitOpen)(struct Adapter *padapter);
int (*NetAiitJoin)(struct Adapter *padapter, int dev_type, char* net_id);
int (*NetAiitSend)(struct Adapter *padapter, const char* data, int len, bool block, int time_out, int delay, send_success cb, void* param, void* reserved);
int (*NetAiitReceive)(struct Adapter *padapter, char* rev_buffer, int buffer_len,int time_out, bool block, void* reserved);
int (*NetAiitIoctl)(struct Adapter *padapter, int cmd, void *arg);
}; };
``` ```
ops成员包含统一的、类似文件系统的API，用于对网络适配器进行实际的数据读写。在使用一个网络适配器前后需要打开（open）/关闭（close）该网络适配器，send、receive分别用与从网络适配器接收数据与向网络适配器发送数据，ioctl用于配置Adapter属性： 最后，在系统中每种网络协议的Adapter被分别组织成不同双链表，如Lora的Adapter链表、4G的Adapter链表等，使用的链表节点即为link成员。
```c
struct xs_AdapterOps {
    int (*open)(struct xs_Adapter *sadapter);
    void (*close)(struct xs_Adapter *sadapter);
    int (*join)(struct xs_Adapter *sadapter,int net_type, int dev_type, int net_number);
    int (*send)(struct xs_Adapter *sadapter, const char* data, int len, int des_dev, int time_out, bool block, int delay);
    int (*receive)(struct xs_Adapter *sadapter, char* rev_buffer, int buffer_len, int time_out, bool block);
    int (*ioctl)(struct xs_Adapter *sadapter, int cmd, void *arg);
};
```
其中需要注意的是，join接口的所使用的net_type和dev_type参数，分别来自枚举：
```c
enum xs_net_type{
    XS_CENTRALIZATION = 0,
    XS_ADHOC,
};
enum xs_dev_type{
    XS_CLIENT = 0,
    XS_GATEWAY,
};
```
net_type代表的含义是，使用传统的中心化网络或者自组网络。dev_type代表的含义是，此设备是普通设备或者网关设备。
最后，在系统中每种网络协议的xs_Adapter被分别组织成不同双链表，如Lora的xs_Adapter链表、4G的xs_Adapter链表等，使用的链表节点即为link成员。
## 2. XiUOS网络框架驱动开发 ## 2. XiUOS网络框架驱动开发
以Lora网络适配器为例。网络框架针对每个具体的网络适配器将xs_Adapter进行扩充，采用类似面向对象的手段添加其他必要成员，如： 以Lora网络适配器为例。网络框架针对每个具体的网络适配器将Adapter进行扩充，采用类似面向对象的手段添加其他必要成员，如：
```c ```c
struct xs_AdapterLora { struct AdapterLora {
    struct xs_Adapter parent; /* inherit from xs_Adapter */ struct Adapter parent; /* inherit from Adapter */
    const char *deve_ui;  /* Lora specific value */ const char * name; /* name of the adapter instance */
    const char *app_key;  /* Lora specific value */
const char *deve_ui; /* Lora specific value */
const char *app_key; /* Lora specific value */
int spi_lora_fd;
}; };
``` ```
实现xs_AdapterOps中的数据通信API，具体实现细节取决于所使用网络协议，无法实现的API可以置为NULL： 实现AdapterOps中的数据通信API，具体实现细节取决于所使用网络协议，无法实现的API可以置为NULL：
```c ```c
struct xs_AdapterOps lora_example_ops = { struct AdapterDone lora_example_done = {
    .open = lora_example_open;     .open = LoraExampleOpen;
    .close = lora_example_close;     .close = LoraExampleClose;
    .send = lora_example_send;     .send = LoraExampleSend;
    .receive = NULL;     .receive = NULL;
    .ioctl = lora_example_ioctl;     .ioctl = LoraExampleIoctl;
}; };
``` ```
填充xs_AdapterLora,并将其注册。 填充AdapterLora,并将其注册。
```c ```c
int xs_AdapterRegister(struct xs_Adapter *sadapter); void LoraAdapterRegister(struct Adapter * padapter);
extern struct xs_AdapterOps lora_example_ops; extern struct AdapterDone lora_example_done;
/* declare xs_AdapterLora */ /* declare AdapterLora */
struct xs_AdapterLora lora_example_adapter; struct AdapterLora lora_example_adapter;
void register_lora_adapter() void register_lora_adapter()
{ {
    /* initialize and register the xs_Adapter object */     /* initialize and register the Adapter object */
    memset(&lora_example_adapter, 0, sizeof(lora_example_adapter));     memset(&lora_example_adapter, 0, sizeof(lora_example_adapter));
    lora_example_adapter.parent.name = "adapter1";     lora_example_adapter.parent.type = ADAPTER_LORA;
    lora_example_adapter.parent.type = XS_ADAPTER_LORA; lora_example_adapter.parent.mesh_type = NET_ADHOC_SINGLE_GROUP;
    lora_example_adapter.parent.info.vendor = "xxx";     lora_example_adapter.parent.done = &lora_example_done;
    lora_example_adapter.parent.info.product_model = "yyy";     lora_example_adapter.spi_lora_fd = open(LORA_SPI_NAME,O_RDWR);
    lora_example_adapter.parent.ops = &lora_example_ops;
    lora_example_adapter.parent.interface.bus_device = xs_DeviceFind("uart1");
    lora_example_adapter.deve_ui = "mmm";     lora_example_adapter.deve_ui = "mmm";
    lora_example_adapter.app_key = "nnn";     lora_example_adapter.app_key = "nnn";
    xs_AdapterRegister(&lora_example_adapter);     LoraAdapterRegister(&lora_example_adapter);
} }
``` ```
## 3. XiUOS网络框架的使用实例 ## 3. XiUOS网络框架的使用实例
网络应用开发者使用网络框架提供的API操作网络适配器，网络适配器API可以分为通用API与协议特有API。通用API用于网络适配器的获取、打开与关闭，协议特有API用于特定协议的数据采样。以Lora网络适配器为例： 网络应用开发者使用网络框架提供的API操作网络适配器，网络适配器API可以分为通用API与协议特有API。通用API用于网络适配器的获取、打开与关闭，协议特有API用于特定协议的传输功能。以Lora网络适配器为例：
```c
/* generic API: find a adapter instance by its name */
struct xs_Adapter *xs_AdapterFind(const char *name);
/* generic API: open/close a adapter instance */
int xs_AdapterOpen(struct xs_Adapter *adapter);
void xs_AdapterClose(struct xs_Adapter *adapter);
/* Lora API: get current Lora adapter reading */
uint32_t xs_AdapterReceive(struct xs_Adapter *adapter, char* rev_buffer, int buffer_len，int time_out, bool block);
```
在获取数据前，需要先获取并打开要使用的网络适配器；网络适配器打开后可以随时对网络适配器数据进行读取；使用完毕后，须关闭网络适配器。完整的使用过程示例如下： 在获取数据前，需要先获取并打开要使用的网络适配器；网络适配器打开后可以随时对网络适配器数据进行读取；使用完毕后，须关闭网络适配器。完整的使用过程示例如下：
```c ```c
#define BUFFER_MAX 512 #define BUFFER_MAX 512
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
int ret; int ret;
    char rev_buffer[BUFFER_MAX];     char rev_buffer[BUFFER_MAX];
    struct xs_Adapter *adapter;     struct Adapter *adapter;
    struct xs_AdapterLora *lora_adapter;     struct AdapterLora *lora_adapter;
    /* get the Lora adapter instance */     /* get the Lora adapter instance */
    adapter = xs_AdapterFind("lora_1");     adapter = LoraAdapterFind("lora_1");
    XS_ASSERT(adapter->type == XS_ADAPTER_LORA);     XS_ASSERT(adapter->type == ADAPTER_LORA);
    /* open the Lora adapter instance */     /* open the Lora adapter instance */
    lora_adapter = (struct xs_AdapterLora *)adapter;     lora_adapter = (struct AdapterLora *)adapter;
    ret = xs_AdapterOpen(adapter); ret = adapter->done.NetAiitOpen(adapter)
    XS_ASSERT(ret == XS_EOK);     XS_ASSERT(ret == XS_EOK);
   adapter->done.NetAiitReceive(adapter, rev_buffer, BUFFER_MAX, 0, 1, 0);
    xs_AdapterReceive(adapter, rev_buffer, BUFFER_MAX, 0, true);     printf("Data read from lora_adapter is %s \n", rev_buffer);
    xs_kprintf("Data read from lora_adapter is %s \n", rev_buffer); adapter->done.NetAiitClose(adapter)
    xs_AdapterClose(adapter);
    return 0;     return 0;
} }
``` ```