VSF的RAD开发方式

之前把VSF的几种底层任务形式都简单介绍了一边，后面就线跳过VSF里的中间层，先用一个应用demo来演示一下VSF的应用层开发方式。

VSF的应用层开发理念就是RAD的开发理念，一个应用是由多个具备一定通用性的模块拼装而成的。VSF提供了不少中间件模块，包括USB主从机协议栈、TCPIP协议栈、文件系统、流驱动、快驱动等开源的模块，也有蓝牙协议栈、80211、MFI等不开源的模块。而这些模块都会尽可能使用通用的接口来实现，所以模块之间很容易互联。下面就上demo，应用是实现一个USB设备，模拟一个U盘，通过简单的方式可以定义U盘里的文件，并且可以指定当主机访问这些文件时候调用的读写接口。

代码在这里：https://github.com/versaloon/vsf/blob/master/vsf/example/mscboot/usrapp.c

220行代码中，大部分都只是数据定义，这些数据定义就是对应了一个模块的互联关系，如下图：

vsf_mscboot.png

模块和互联关系说明：

1. vsfhal_usbd：VSF中MCU自带的USB设备底层驱动，类型是vsfhal_usbd_t，用于设置vsfusbd_device_t（USB设备数据结构）的drv属性。

.usbd.device.drv                        = (struct vsfhal_usbd_t *)&vsfhal_usbd,

2. vsfusbd：VSF中的通用USB设备协议栈。应用里，通过vsfusbd_device_t数据结构来指定USB的各个功能。比如，可以通过drv属性来指定底层USB设备驱动（可以是芯片自带的USBD接口的驱动vsfhal_usbd；也可以是GPIO模拟的USBD接口驱动vsfsdcd_usbd；也可以是vbus中vbususbd的接口驱动vbususbd_drv；或者是其他各种符合vsfhal_usbd_t的USB设备驱动）。vsfusbd_device_t中可以自己定义config，config中可以定义interface。本示例中，interface0实现为一个MSC设备。

.usbd.ifaces[0].class_protocol          = (struct vsfusbd_class_protocol_t *)&vsfusbd_MSCBOT_class,
.usbd.ifaces[0].protocol_param          = &usrapp.usbd.msc.param,

3. VSF中的U盘设备端驱动就是vsfusbd_MSCBOT_class。数据结构中，需要定义输入输出的端点和一个scsi设备。

.usbd.msc.param.ep_in                   = 1,
.usbd.msc.param.ep_out                  = 1,
.usbd.msc.param.scsi_dev                = &usrapp.mal.scsi_dev,

3. scsi设备在VSF中的定义是，可以接收scsi命令流，返回scsi应答流的设备。scsi设备可以具备多个lun（逻辑单元）。示例中，只有一个逻辑单元，是mal2scsi。

.mal.lun[0].op                          = (struct vsfscsi_lun_op_t *)&vsf_mal2scsi_op,
// lun->stream MUST be scsistream for mal2scsi
.mal.lun[0].stream                      = (struct vsf_stream_t *)&usrapp.mal.scsistream,
.mal.lun[0].param                       = &usrapp.mal.mal2scsi,
.mal.scsi_dev.max_lun                   = 0,
.mal.scsi_dev.lun                       = usrapp.mal.lun,

4. mal2scsi是VSF中，把块设备（mal）转化为scsi设备的模块。mal2scsi会把scsi的读写命令交由块设备执行，并且自行处理其他块设备不支持的命令。

.mal.mal2scsi.malstream.mal             = &usrapp.mal.mal,
.mal.mal2scsi.cparam.block_size         = 512,
.mal.mal2scsi.cparam.removable          = false,
.mal.mal2scsi.cparam.vendor             = "Simon   ",
.mal.mal2scsi.cparam.product            = "VSFDriver       ",
.mal.mal2scsi.cparam.revision           = "1.00",
.mal.mal2scsi.cparam.type               = SCSI_PDT_DIRECT_ACCESS_BLOCK,

5. fakefat32是VSF中用来方便模拟一个fat32文件系统的模块，可以输出2个标准接口，一个是fakefat32_mal_drv块设备接口，另一个是fakefat32_fs_op文件系统接口。示例中是使用了块设备接口，因为mal2scsi需要连接一个块设备。

.mal.fakefat32.sector_size              = 512,
.mal.fakefat32.sector_number            = 0x00001000,
.mal.fakefat32.sectors_per_cluster      = 8,
.mal.fakefat32.volume_id                = 0x0CA93E47,
.mal.fakefat32.disk_id                  = 0x12345678,
.mal.fakefat32.root[0].memfile.file.name= "ROOT",
.mal.fakefat32.root[0].memfile.d.child  = (struct vsfile_memfile_t *)fakefat32_root_dir,

.mal.mal.drv                            = &fakefat32_mal_drv,
.mal.mal.param                          = &usrapp.mal.fakefat32,

6. root_dir是fakefat32的输入，是一个数组数据，用于指定模拟的FAT32文件系统里的文件和目录。示例中定义了volum_id，定义了fw.bin、config.bin、config.py三个文件。并且，文件可以定义读写接口。

static struct fakefat32_file_t fakefat32_root_dir[] =
{
    {
        .memfile.file.name = "VSF_UPDATE",
        .memfile.file.attr = VSFILE_ATTR_VOLUMID,
    },
    {
        .memfile.file.name = "fw.bin",
        .memfile.file.size = APPCFG_FW_SIZE,
        .memfile.file.attr = VSFILE_ATTR_ARCHIVE,
        .cb.read = read_firmware,
        .cb.write = write_firmware,
    },
    {
        .memfile.file.name = "config.bin",
        .memfile.file.size = sizeof(struct msc_config_t),
        .memfile.file.attr = VSFILE_ATTR_ARCHIVE | VSFILE_ATTR_HIDDEN | VSFILE_ATTR_SYSTEM,
        .cb.read = read_config,
        .cb.write = write_config,
    },
    {
        .memfile.file.name = "config.py",
        .memfile.file.size = sizeof(config) - 1,
        .memfile.file.attr = VSFILE_ATTR_ARCHIVE | VSFILE_ATTR_READONLY,
        .memfile.f.buff = (uint8_t *)config,
    },
    {
        .memfile.file.name = NULL,
    },
};

这些数据结构就决定了应用，然后只需要配合少量的代码，就可以运行起来了。代码也只是先关闭USB，200ms后，初始化一些数据结构，初始化scsi设备和usbd设备，然后连接USB。

static void usrapp_usbd_conn(void *p)
{
    struct usrapp_t *app = (struct usrapp_t *)p;

    vsfhal_flash_init(0);

    // mal init
    for (int i = 0; i < dimof(app->mal.buffer); i++)
        app->mal.pbuffer[i] = app->mal.buffer[i];
    vsfscsi_init(&app->mal.scsi_dev);
    vsfusbd_device_init(&app->usbd.device);

    app->usbd.device.drv->connect();
    if (app->hwcfg->usbd.pullup.port != VSFHAL_DUMMY_PORT)
        vsfhal_gpio_set(app->hwcfg->usbd.pullup.port, 1 << app->hwcfg->usbd.pullup.pin);
}

void usrapp_srt_init(struct usrapp_t *app)
{
    if (app->hwcfg->usbd.pullup.port != VSFHAL_DUMMY_PORT)
    {
        vsfhal_gpio_init(app->hwcfg->usbd.pullup.port);
        vsfhal_gpio_clear(app->hwcfg->usbd.pullup.port, 1 << app->hwcfg->usbd.pullup.pin);
        vsfhal_gpio_config_pin(app->hwcfg->usbd.pullup.port, app->hwcfg->usbd.pullup.pin, GPIO_OUTPP);
    }
    app->usbd.device.drv->disconnect();

    vsftimer_create_cb(200, 1, usrapp_usbd_conn, app);
}