sys/contrib/ncsw/inc/etc/sprint_ext.h

   1 /* Copyright (c) 2008-2011 Freescale Semiconductor, Inc.
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *     * Redistributions of source code must retain the above copyright
   7  *       notice, this list of conditions and the following disclaimer.
   8  *     * Redistributions in binary form must reproduce the above copyright
   9  *       notice, this list of conditions and the following disclaimer in the
  10  *       documentation and/or other materials provided with the distribution.
  11  *     * Neither the name of Freescale Semiconductor nor the
  12  *       names of its contributors may be used to endorse or promote products
  13  *       derived from this software without specific prior written permission.
  14  *
  15  *
  16  * ALTERNATIVELY, this software may be distributed under the terms of the
  17  * GNU General Public License ("GPL") as published by the Free Software
  18  * Foundation, either version 2 of that License or (at your option) any
  19  * later version.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
  22  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24  * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
  25  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  28  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /******************************************************************************
  34
  35  @File          sprint_ext.h
  36
  37  @Description   Debug routines (externals).
  38
  39 *//***************************************************************************/
  40
  41 #ifndef __SPRINT_EXT_H
  42 #define __SPRINT_EXT_H
  43
  44
  45 #if defined(NCSW_LINUX) && defined(__KERNEL__)
  46 #include <linux/kernel.h>
  47
  48 #elif defined(NCSW_LINUX_USD)
  49 #include <stdio.h>
  50 #include "stdarg_ext.h"
  51 #include "std_ext.h"
  52
  53 extern int vsscanf(const char *, const char *, va_list);
  54
  55 #elif defined(NCSW_VXWORKS)
  56 #include "private/stdioP.h"
  57
  58 #elif defined(NCSW_FREEBSD)
  59 #include <sys/param.h>
  60 #include <sys/kernel.h>
  61 #include <sys/libkern.h>
  62
  63 #else
  64 #include <stdio.h>
  65 #endif /* defined(NCSW_LINUX) && defined(__KERNEL__) */
  66
  67 #include "std_ext.h"
  68
  69
  70 /**************************************************************************//**
  71  @Group         etc_id   Utility Library Application Programming Interface
  72
  73  @Description   External routines.
  74
  75  @{
  76 *//***************************************************************************/
  77
  78 /**************************************************************************//**
  79  @Group         sprint_id Sprint
  80
  81  @Description   Sprint & Sscan module functions,definitions and enums.
  82
  83  @{
  84 *//***************************************************************************/
  85
  86 /**************************************************************************//**
  87  @Function      Sprint
  88
  89  @Description   Format a string and place it in a buffer.
  90
  91  @Param[in]     buff - The buffer to place the result into.
  92  @Param[in]     str  - The format string to use.
  93  @Param[in]     ...  - Arguments for the format string.
  94
  95  @Return        Number of bytes formatted.
  96 *//***************************************************************************/
  97 int Sprint(char *buff, const char *str, ...);
  98
  99 /**************************************************************************//**
 100  @Function      Snprint
 101
 102  @Description   Format a string and place it in a buffer.
 103
 104  @Param[in]     buf  - The buffer to place the result into.
 105  @Param[in]     size - The size of the buffer, including the trailing null space.
 106  @Param[in]     fmt  - The format string to use.
 107  @Param[in]     ...  - Arguments for the format string.
 108
 109  @Return        Number of bytes formatted.
 110 *//***************************************************************************/
 111 int Snprint(char * buf, uint32_t size, const char *fmt, ...);
 112
 113 /**************************************************************************//**
 114  @Function      Sscan
 115
 116  @Description   Unformat a buffer into a list of arguments.
 117
 118  @Param[in]     buf  - input buffer.
 119  @Param[in]     fmt  - formatting of buffer.
 120  @Param[out]    ...  - resulting arguments.
 121
 122  @Return        Number of bytes unformatted.
 123 *//***************************************************************************/
 124 int Sscan(const char * buf, const char * fmt, ...);
 125
 126 /** @} */ /* end of sprint_id group */
 127 /** @} */ /* end of etc_id group */
 128
 129
 130 #endif /* __SPRINT_EXT_H */