xref: /freebsd/sys/contrib/ncsw/inc/etc/sprint_ext.h (revision a7623790fb345e6dc986dfd31df0ace115e6f2e4)
1 /* Copyright (c) 2008-2012 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_VXWORKS)
49 #include "private/stdioP.h"
50 
51 #elif defined(NCSW_FREEBSD)
52 #include <sys/param.h>
53 #include <sys/kernel.h>
54 #include <sys/libkern.h>
55 
56 #else
57 #include <stdio.h>
58 #endif /* defined(NCSW_LINUX) && defined(__KERNEL__) */
59 
60 #include "std_ext.h"
61 
62 
63 /**************************************************************************//**
64  @Group         etc_id   Utility Library Application Programming Interface
65 
66  @Description   External routines.
67 
68  @{
69 *//***************************************************************************/
70 
71 /**************************************************************************//**
72  @Group         sprint_id Sprint
73 
74  @Description   Sprint & Sscan module functions,definitions and enums.
75 
76  @{
77 *//***************************************************************************/
78 
79 /**************************************************************************//**
80  @Function      Sprint
81 
82  @Description   Format a string and place it in a buffer.
83 
84  @Param[in]     buff - The buffer to place the result into.
85  @Param[in]     str  - The format string to use.
86  @Param[in]     ...  - Arguments for the format string.
87 
88  @Return        Number of bytes formatted.
89 *//***************************************************************************/
90 int Sprint(char *buff, const char *str, ...);
91 
92 /**************************************************************************//**
93  @Function      Snprint
94 
95  @Description   Format a string and place it in a buffer.
96 
97  @Param[in]     buf  - The buffer to place the result into.
98  @Param[in]     size - The size of the buffer, including the trailing null space.
99  @Param[in]     fmt  - The format string to use.
100  @Param[in]     ...  - Arguments for the format string.
101 
102  @Return        Number of bytes formatted.
103 *//***************************************************************************/
104 int Snprint(char * buf, uint32_t size, const char *fmt, ...);
105 
106 /**************************************************************************//**
107  @Function      Sscan
108 
109  @Description   Unformat a buffer into a list of arguments.
110 
111  @Param[in]     buf  - input buffer.
112  @Param[in]     fmt  - formatting of buffer.
113  @Param[out]    ...  - resulting arguments.
114 
115  @Return        Number of bytes unformatted.
116 *//***************************************************************************/
117 int Sscan(const char * buf, const char * fmt, ...);
118 
119 /** @} */ /* end of sprint_id group */
120 /** @} */ /* end of etc_id group */
121 
122 
123 #endif /* __SPRINT_EXT_H */
124