/*!
|
\file dfu_mal.h
|
\brief USB DFU device media access layer header file
|
|
\version 2020-08-01, V3.0.0, firmware for GD32F30x
|
*/
|
|
/*
|
Copyright (c) 2020, GigaDevice Semiconductor Inc.
|
|
Redistribution and use in source and binary forms, with or without modification,
|
are permitted provided that the following conditions are met:
|
|
1. Redistributions of source code must retain the above copyright notice, this
|
list of conditions and the following disclaimer.
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
this list of conditions and the following disclaimer in the documentation
|
and/or other materials provided with the distribution.
|
3. Neither the name of the copyright holder nor the names of its contributors
|
may be used to endorse or promote products derived from this software without
|
specific prior written permission.
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
|
OF SUCH DAMAGE.
|
*/
|
|
#ifndef __DFU_MAL_H
|
#define __DFU_MAL_H
|
|
#include "usbd_conf.h"
|
|
typedef struct _dfu_mal_prop
|
{
|
const uint8_t* pstr_desc;
|
|
uint8_t (*mal_init) (void);
|
uint8_t (*mal_deinit) (void);
|
uint8_t (*mal_erase) (uint32_t addr);
|
uint8_t (*mal_write) (uint8_t *buf, uint32_t addr, uint32_t len);
|
uint8_t* (*mal_read) (uint8_t *buf, uint32_t addr, uint32_t len);
|
uint8_t (*mal_checkaddr) (uint32_t addr);
|
|
const uint32_t erase_timeout;
|
const uint32_t write_timeout;
|
} dfu_mal_prop;
|
|
typedef enum
|
{
|
MAL_OK = 0,
|
MAL_FAIL
|
} MAL_Status;
|
|
#define _1st_BYTE(x) (uint8_t)((x) & 0xFF) /*!< addressing cycle 1st byte */
|
#define _2nd_BYTE(x) (uint8_t)(((x) & 0xFF00) >> 8) /*!< addressing cycle 2nd byte */
|
#define _3rd_BYTE(x) (uint8_t)(((x) & 0xFF0000) >> 16) /*!< addressing cycle 3rd byte */
|
|
#define SET_POLLING_TIMEOUT(x) buffer[0] = _1st_BYTE(x);\
|
buffer[1] = _2nd_BYTE(x);\
|
buffer[2] = _3rd_BYTE(x);
|
|
/* function declarations */
|
/* initialize the memory media on the GD32 */
|
uint8_t dfu_mal_init(void);
|
/* deinitialize the memory media on the GD32 */
|
uint8_t dfu_mal_deinit(void);
|
/* erase a memory sector */
|
uint8_t dfu_mal_erase(uint32_t addr);
|
/* write data to sectors of memory */
|
uint8_t dfu_mal_write(uint8_t *buf, uint32_t addr, uint32_t len);
|
/* read data from sectors of memory */
|
uint8_t* dfu_mal_read(uint8_t *buf, uint32_t addr, uint32_t len);
|
/* get the status of a given memory and store in buffer */
|
uint8_t dfu_mal_getstatus(uint32_t addr, uint8_t cmd, uint8_t *buffer);
|
|
#endif /* __DFU_MAL_H */
|
