diff options
Diffstat (limited to 'arch/arm/plat-omap/include/dspbridge/util.h')
-rw-r--r-- | arch/arm/plat-omap/include/dspbridge/util.h | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/arch/arm/plat-omap/include/dspbridge/util.h b/arch/arm/plat-omap/include/dspbridge/util.h new file mode 100644 index 000000000000..e6815caf2d2b --- /dev/null +++ b/arch/arm/plat-omap/include/dspbridge/util.h @@ -0,0 +1,122 @@ +/* + * util.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== util.h ======== + * Purpose: + * Provide general purpose utility functions. + * + * Public Functions: + * UTIL_CDTestDll + * UTIL_CmdLineToArgs + * UTIL_Exit + * UTIL_GetSysInfo + * UTIL_Init + */ + +#ifndef _UTIL_H +#define _UTIL_H + +#include <linux/delay.h> +#include <linux/sched.h> + +#include <dspbridge/utildefs.h> + +/* + * ======== UTIL_CDTestDll ======== + * Purpose: + * Provides test entry point in class driver context. + * Parameters: + * cArgc: test module command line input count. + * ppArgv: test module command line args. + * Returns: + * 0 if successful, a negative value otherwise. + * Requires: + * UTIL initialized. + * Ensures: + */ + extern u32 UTIL_CDTestDll(IN s32 cArgc, IN char **ppArgv); + +/* + * ======== UTIL_CmdLineToArgs ======== + * Purpose: + * This function re-creates C-style cmd line argc & argv from WinMain() + * cmd line args. + * Parameters: + * s8 *pszProgName - The name of the program currently being executed. + * s8 *argv[] - The argument vector. + * s8 *pCmdLine - The pointer to the command line. + * bool fHasProgName - Indicats whether a program name is supplied. + * Returns: + * Returns the number of arguments found. + * Requires: + * UTIL initialized. + * Ensures: + */ + extern s32 UTIL_CmdLineToArgs(IN char *pszProgName, + IN char *argv[UTIL_MAXARGVS], + IN char *pCmdLine, IN bool fHasProgName); + +/* + * ======== UTIL_Exit ======== + * Purpose: + * Discontinue usage of module; free resources when reference count + * reaches 0. + * Parameters: + * Returns: + * Requires: + * UTIL initialized. + * Ensures: + * Resources used by module are freed when cRef reaches zero. + */ + extern inline void UTIL_Exit(void) + { + } +/* + * ======== UTIL_GetSysInfo ======== + * Purpose: + * This function return platform specific system information. + * + * Parameters: + * pSysInfo - address to store the system information. + * Returns: + * DSP_SOK + * S_FAIL + * Requires: + * UTIL initialized. + * pSysInfo != NULL + * Ensures: + */ + extern DSP_STATUS UTIL_GetSysInfo(OUT struct UTIL_SYSINFO *pSysInfo); + +/* + * ======== UTIL_Init ======== + * Purpose: + * Initializes private state of UTIL module. + * Parameters: + * Returns: + * TRUE if success, else FALSE. + * Requires: + * Ensures: + * UTIL initialized. + */ + extern inline bool UTIL_Init(void) + { + return true; + } + +#endif /* _UTIL_H */ |