summaryrefslogtreecommitdiff
path: root/utilities/fsl_debug_console.h
diff options
context:
space:
mode:
authorDominik Sliwa <dominik.sliwa@toradex.com>2017-05-16 14:31:59 +0200
committerDominik Sliwa <dominik.sliwa@toradex.com>2017-05-16 14:31:59 +0200
commitc9d5d6b248a12f7c6b66d8a64b93fb0c8c6cae4d (patch)
treedc9f3329f9fd2fc67aa8202b2d3cb4e537deb17d /utilities/fsl_debug_console.h
parentd0e5a94a55334b0a27652959fba5066f56128135 (diff)
ksd:ksdk update to 2.2
This include FreeRTOS update to version 9.0.0 Signed-off-by: Dominik Sliwa <dominik.sliwa@toradex.com>
Diffstat (limited to 'utilities/fsl_debug_console.h')
-rw-r--r--utilities/fsl_debug_console.h28
1 files changed, 14 insertions, 14 deletions
diff --git a/utilities/fsl_debug_console.h b/utilities/fsl_debug_console.h
index 3ef50cf..6c50de5 100644
--- a/utilities/fsl_debug_console.h
+++ b/utilities/fsl_debug_console.h
@@ -1,6 +1,6 @@
/*
* Copyright (c) 2013 - 2015, Freescale Semiconductor, Inc.
- * All rights reserved.
+ * Copyright 2016-2017 NXP
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
@@ -12,7 +12,7 @@
* list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
- * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
+ * o 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.
*
@@ -64,12 +64,12 @@
#include <stdio.h>
#endif
-/*! @brief Definition to printf float number. */
+/*! @brief Definition to printf the float number. */
#ifndef PRINTF_FLOAT_ENABLE
#define PRINTF_FLOAT_ENABLE 0U
#endif /* PRINTF_FLOAT_ENABLE */
-/*! @brief Definition to scanf float number. */
+/*! @brief Definition to scanf the float number. */
#ifndef SCANF_FLOAT_ENABLE
#define SCANF_FLOAT_ENABLE 0U
#endif /* SCANF_FLOAT_ENABLE */
@@ -108,22 +108,22 @@ extern "C" {
/* @{ */
/*!
- * @brief Initialize the the peripheral used for debug messages.
+ * @brief Initializes the the peripheral used for debug messages.
*
* Call this function to enable debug log messages to be output via the specified peripheral,
- * frequency of peripheral source clock, base address at the specified baud rate.
- * After this function has returned, stdout and stdin will be connected to the selected peripheral.
+ * frequency of peripheral source clock, and base address at the specified baud rate.
+ * After this function has returned, stdout and stdin are connected to the selected peripheral.
*
- * @param baseAddr Which address of peripheral is used to send debug messages.
+ * @param baseAddr Indicates the address of the peripheral used to send debug messages.
* @param baudRate The desired baud rate in bits per second.
- * @param device Low level device type for the debug console, could be one of:
+ * @param device Low level device type for the debug console, can be one of the following.
* @arg DEBUG_CONSOLE_DEVICE_TYPE_UART,
* @arg DEBUG_CONSOLE_DEVICE_TYPE_LPUART,
* @arg DEBUG_CONSOLE_DEVICE_TYPE_LPSCI,
* @arg DEBUG_CONSOLE_DEVICE_TYPE_USBCDC.
* @param clkSrcFreq Frequency of peripheral source clock.
*
- * @return Whether initialization was successful or not.
+ * @return Indicates whether initialization was successful or not.
* @retval kStatus_Success Execution successfully
* @retval kStatus_Fail Execution failure
* @retval kStatus_InvalidArgument Invalid argument existed
@@ -131,12 +131,12 @@ extern "C" {
status_t DbgConsole_Init(uint32_t baseAddr, uint32_t baudRate, uint8_t device, uint32_t clkSrcFreq);
/*!
- * @brief De-initialize the peripheral used for debug messages.
+ * @brief De-initializes the peripheral used for debug messages.
*
* Call this function to disable debug log messages to be output via the specified peripheral
* base address and at the specified baud rate.
*
- * @return Whether de-initialization was successful or not.
+ * @return Indicates whether de-initialization was successful or not.
*/
status_t DbgConsole_Deinit(void);
@@ -144,10 +144,10 @@ status_t DbgConsole_Deinit(void);
/*!
* @brief Writes formatted output to the standard output stream.
*
- * Call this function to Writes formatted output to the standard output stream.
+ * Call this function to write a formatted output to the standard output stream.
*
* @param fmt_s Format control string.
- * @return Returns the number of characters printed, or a negative value if an error occurs.
+ * @return Returns the number of characters printed or a negative value if an error occurs.
*/
int DbgConsole_Printf(const char *fmt_s, ...);