rt-thread/bsp/lpc54114-lite/Libraries/devices/LPC54114/utilities/io/swo/fsl_swo.h

/*
 * The Clear BSD License
 * Copyright 2018 NXP
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted (subject to the limitations in the disclaimer below) provided
 *  that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
 * 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 _FSL_SWO_H_
#define _FSL_SWO_H_

#include "fsl_common.h"

/*!
 * @addtogroup debugconsole
 * @{
 */

/*******************************************************************************
 * Definitions
 ******************************************************************************/
/* swo protocol */
enum _swo_protocol
{
    kSWO_ProtocolManchester = 1U, /*!< SWO manchester protocol */
    kSWO_ProtocolNrz = 2U,        /*!< SWO UART/NRZ protocol */
};

/*******************************************************************************
 * Prototypes
 ******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif /* __cplusplus */

/*!
 * @brief io init function.
 *
 * Call this function to init SWO.
 *
 * @param port port used to transfer data
 * @param baudRate SWO clock
 * @param clkSrcFreq core clock frequency
 */
status_t SWO_Init(uint32_t port, uint32_t baudRate, uint32_t clkSrcFreq);

/*!
 * @brief Deinit IO.
 *
 * Call this function to Deinit SWO.
 *
 * @param port port to deinit.
 * @return deinit status
 */
void SWO_Deinit(uint32_t port);

/*!
 * @brief io transfer function.
 *
 * Call this function to print log.
 *
 * @param port port used to transfer data
 * @param ch  transfer buffer pointer
 * @param size transfer size
 */
status_t SWO_SendBlocking(uint32_t port, uint8_t *ch, size_t size);

#if defined(__cplusplus)
}
#endif /* __cplusplus */

/*! @} */

#endif /* _FSL_SWO_H_ */