jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases Activity

stm32: desig: doc: merge duplicate documentation sections

Browse Source 
Use the best one.
This commit is contained in:
Karl Palsson 2020-01-28 23:03:39 +00:00
parent 8c37e5cea0
commit 7da29d3d5f
2 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/libopencm3/stm32/desig.h
View File

@ -53,10 +53,18 @@ void desig_get_unique_id_as_string(char *string,
unsigned int string_len); unsigned int string_len);
/** /**
* Returns the same serial number that the factory DFU * Generate the same serial number from the unique id registers as
* bootloader reports (via USB descriptors). * the DFU bootloader.
* @param string memory region to write the result to. This is *
* expected to be a 13-byte buffer. * This document: http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf
* says that the serial number has to be at least 12 digits long and that
* the last 12 digits need to be unique. It also stipulates that the valid
* character set is that of upper-case hexadecimal digits.
* The onboard DFU bootloader produces a 12-digit serial based on the
* 96-bit unique ID. Show the serial with ```dfu-util -l``` while the
* MCU is in DFU mode.
* @see https://my.st.com/52d187b7 for the algorithim used.
* @param string pointer to store serial in, must be at least 13 bytes
*/ */
void desig_get_unique_id_as_dfu(char *string); void desig_get_unique_id_as_dfu(char *string);

12
lib/stm32/desig.c
View File

@ -53,18 +53,6 @@ void desig_get_unique_id_as_string(char *string,
string[len] = '\0'; string[len] = '\0';
} }
/**
* Generate a serial number from the unique id registers as the DFU bootloader.
* This document: http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf
* says that the serial number has to be at least 12 digits long and that
* the last 12 digits need to be unique. It also stipulates that the valid
* character set is that of upper-case hexadecimal digits.
* The onboard DFU bootloader produces a 12-digit serial based on the
* 96-bit unique ID. Show the serial with ```dfu-util -l``` while the
* MCU is in DFU mode.
* @see https://my.st.com/52d187b7 for the algorithim used.
* @param string pointer to store serial in, must be at least 13 bytes
*/
void desig_get_unique_id_as_dfu(char *string) { void desig_get_unique_id_as_dfu(char *string) {
uint8_t *id = (uint8_t *)DESIG_UNIQUE_ID_BASE; uint8_t *id = (uint8_t *)DESIG_UNIQUE_ID_BASE;