Arrow / Mbed OS DAPLink Reset
Embed: (wiki syntax)

« Back to documentation index

target_board.h File Reference

target_board.h File Reference

DAPLink Interface Firmware Copyright (c) 2018-2019, ARM Limited, All Rights Reserved SPDX-License-Identifier: Apache-2.0. More...

Go to the source code of this file.

Enumerations

enum  _board_info_version { kBoardInfoVersion = 1 }
 

Current board info version.

More...
enum  _board_info_flags { kEnablePageErase = (1 << 0), kEnableUnderResetConnect = (1 << 1) }
 

Flags for board_info.

More...

Board initialization customization

 board_info_t
const board_info_t g_board_info
 Information describing the board on which DAPLink is running.
const char * get_board_id (void)
 Returns the 4-char ID of the board used by the running firmware.
uint16_t get_family_id (void)
 Returns the family ID for the target associated with the board.
uint8_t flash_algo_valid (void)
 Whether the board has a valid flash algo.
static const char * get_daplink_url_name (void)
 Returns the MSD HTML help filename or a default.
static const char * get_daplink_drive_name (void)
 Returns the MSD volume name or a default.
static const char * get_daplink_target_url (void)
 Returns the target information URL or a default.

Detailed Description

DAPLink Interface Firmware Copyright (c) 2018-2019, ARM Limited, All Rights Reserved SPDX-License-Identifier: Apache-2.0.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file target_board.h.


Enumeration Type Documentation

Flags for board_info.

Enumerator:
kEnablePageErase 

Enable page programming and sector erase for drag and drop

kEnableUnderResetConnect 

Enable under reset connection when enabling debug mode

Definition at line 38 of file target_board.h.

Current board info version.

  • Version 1: Initial version.
Enumerator:
kBoardInfoVersion 

The current board info version.

Definition at line 33 of file target_board.h.


Function Documentation

uint8_t flash_algo_valid ( void   )

Whether the board has a valid flash algo.

Definition at line 56 of file target_board.c.

const char* get_board_id ( void   )

Returns the 4-char ID of the board used by the running firmware.

For firmware with no board, the board ID is "0000".

Definition at line 36 of file target_board.c.

static const char* get_daplink_drive_name ( void   ) [static]

Returns the MSD volume name or a default.

Definition at line 105 of file target_board.h.

static const char* get_daplink_target_url ( void   ) [static]

Returns the target information URL or a default.

Definition at line 108 of file target_board.h.

static const char* get_daplink_url_name ( void   ) [static]

Returns the MSD HTML help filename or a default.

Definition at line 102 of file target_board.h.

uint16_t get_family_id ( void   )

Returns the family ID for the target associated with the board.

The family ID will be 0 if there is no board.

Definition at line 45 of file target_board.c.


Variable Documentation

const board_info_t g_board_info

Information describing the board on which DAPLink is running.

Definition at line 25 of file 6LoWPAN_BorderRouterETHERNET.c.