Skip to content

GitLab

Commit ead37e6a authored by Ben Avison's avatar Ben Avison
Browse files

Import of initial version of SoundControl (HAL variant). 

This module pinches the name, SWI base and error block of its Phoebe
equivalent (now moved to RiscOS/Sources/Audio/SoundCtrlPhoebe), but is a
completely new implementation.
parents
Hide whitespace changes
Inline Side-by-side
Showing with 1838 additions and 0 deletions
.gitattributes 0 → 100644
View file @ ead37e6a
hdr/** gitlab-language=armasm linguist-language=armasm linguist-detectable=true
c/** gitlab-language=c linguist-language=c linguist-detectable=true
h/** gitlab-language=c linguist-language=c linguist-detectable=true
cmhg/** gitlab-language=cmhg linguist-language=cmhg linguist-detectable=true
Docs/SoundCtrl 0 → 100644
View file @ ead37e6a
SoundControl module provides
* *MixVolume <system> <category> <index> <mute> <gain>
system: only 0 defined so far (on-board sound output system)
category: -1 = speaker
-2 = headphones
-3 = line out (not used on Iyonix)
-4 = aux out (a header on the board)
0 = system audio
1 = mic
2 = line in
3 = aux in [index 0 usually CD-ROM]
index: allows eg multiple CD sources
mute: 0 / 1
gain (signed int): dB * 16
* SWI SoundControl_ExamineMixer
In: r0 = system
r1 -> word-aligned block
r2 = block size (may be 0)
Out: block filled with as many as poss of following blocks:
+0,+1 flags: bit 0 set => fixed
bit 1 set => mono
bit 2 set => muted by default
+2,+3 category
r0,r1 preserved
r2 decremented by number of bytes needed for complete description
(ie if 0 on entry, now holds negative of buffer size required)
r3 = individual block size (bytes) - will be a multiple of 4
r4 = number of blocks placed in buffer
Should be called twice, first to determine buffer size, then to fill in buffer.
This is to allow block to be enlarged in future.
* SWI SoundControl_SetMix is equivalent SWI to *MixVolume
r0 = system
r1 = category
r2 = channel index
r3 = mute
r4 = gain
* SWI SoundControl_GetMix
r0 = system
r1 = category
r2 = channel index
on exit:
r3 = mute
r4 = gain
LICENSE 0 → 100644
View file @ ead37e6a
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Makefile 0 → 100644
View file @ ead37e6a
# Copyright 2003 Tematic Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Makefile for SoundCtrl
#
# ***********************************
# *** C h a n g e L i s t ***
# ***********************************
# Date Name Description
# ---- ---- -----------
# 14-Feb-2003 BJGA Created.
COMPONENT = SoundCtrl
TARGET = SoundCtrl
DIRS = local_dirs
CFLAGS = -ffah -zM -zps1 ${DEFINES}
RAM_OBJS = o.module o.resmess ${OBJS}
ROM_OBJS = o.moduleROM ${OBJS}
OBJS = o.global o.mess o.modhdr
DBG_OBJS = do.module do.global do.mess o.modhdr
EXP_HDR = <Export$Dir>
C_EXP_HDR = <CExport$Dir>.Interface
LIBS =
DBG_LIBS = ${LIBS} <Lib$Dir>.DebugLib.o.debuglibzm TCPIPLibs:o.socklib5zm TCPIPLibs:o.inetlibzm
DBG_MODULE = drm.${TARGET}
EXPORTS = ${C_EXP_HDR}.h.MixerDevice ${EXP_HDR}.MixerDevice ${EXP_HDR}.SoundCtrl
include Makefiles:StdTools
include Makefiles:ModuleLibs
include Makefiles:ModStdRule
include Makefiles:RAMCModule
include Makefiles:ROMCModule
.SUFFIXES: .do
.c.do:; ${CC} ${CFLAGS} -DDEBUGLIB -o $@ $<
local_dirs:
${MKDIR} do
${MKDIR} o
export: export_${PHASE}
export_: export_libs export_hdrs
@|
export_hdrs: ${EXPORTS}
@${ECHO} ${COMPONENT}: export hdrs complete
export_libs: ${EXPORTS}
@${ECHO} ${COMPONENT}: export libs complete
${EXP_HDR}.SoundCtrl: hdr.SoundCtrl
${CP} hdr.SoundCtrl $@ ${CPFLAGS}
${EXP_HDR}.MixerDevice: hdr.MixerDevice
${CP} hdr.MixerDevice $@ ${CPFLAGS}
${C_EXP_HDR}.h.MixerDevice: h.MixerDevice
${CP} h.MixerDevice $@ ${CPFLAGS}
resources: o._Messages${CMDHELP}_
${MKDIR} ${RESDIR}.${COMPONENT}
${CP} o._Messages${CMDHELP}_ ${RESDIR}.${COMPONENT}.Messages ${CPFLAGS}
@${ECHO} ${COMPONENT}: resource files copied
clean:
${RM} h.modhdr
ifthere linked then wipe linked ${WFLAGS}
ifthere aof then wipe aof ${WFLAGS}
ifthere drm then wipe drm ${WFLAGS}
ifthere do then wipe do ${WFLAGS}
ifthere rm then wipe rm ${WFLAGS}
ifthere o then wipe o ${WFLAGS}
@${ECHO} ${COMPONENT}: cleaned
debug: ${DBG_MODULE}
@${ECHO} ${COMPONENT}: debug module built
${DBG_MODULE}: ${DBG_OBJS} ${DBG_LIBS} ${CLIB} ${DIRS}
${MKDIR} drm
${LD} ${LDFLAGS} -o $@ -rmf ${DBG_OBJS} ${DBG_LIBS} ${CLIB}
${CHMOD} -R a+rx drm
o.module: modhdr.h
do.module: modhdr.h
moduleROM.o: module.c modhdr.h
${CC} ${CFLAGS} -DROM_MODULE -o moduleROM.o module.c
resmess.o: o._Messages${CMDHELP}_
ResGen resmess_ResourcesFiles o.resmess o._Messages${CMDHELP}_ Resources.SoundCtrl.Messages
o._Messages_: LocalRes:Messages LocalRes:CmdHelp
FAppend $@ LocalRes:Messages LocalRes:CmdHelp
o._MessagesNone_: LocalRes:Messages
${CP} LocalRes:Messages $@ ${CPFLAGS}
# Dynamic dependencies:
MkClean,fd7 0 → 100644
View file @ ead37e6a
| Copyright 2003 Tematic Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine clean %*0
stripdepnd
MkDebug,fd7 0 → 100644
View file @ ead37e6a
| Copyright 2003 Tematic Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine debug THROWBACK=-throwback %*0
MkExport,fd7 0 → 100644
View file @ ead37e6a
| Copyright 2003 Tematic Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine export %*0
MkRam,fd7 0 → 100644
View file @ ead37e6a
| Copyright 2003 Tematic Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine all THROWBACK=-throwback %*0
MkRom,fd7 0 → 100644
View file @ ead37e6a
| Copyright 2003 Tematic Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine rom %*0
Resources/UK/CmdHelp 0 → 100644
View file @ ead37e6a
File added
Resources/UK/Messages 0 → 100644
View file @ ead37e6a
#{DictTokens}
E02:Mixer not found
E03:Mixer channel not found
VersionNum 0 → 100644
View file @ ead37e6a
/* (1.00)
*
* This file is automatically maintained by srccommit, do not edit manually.
* Last processed by srccommit version: 1.68.
*
*/
#define Module_MajorVersion_CMHG 1.00
#define Module_MinorVersion_CMHG
#define Module_Date_CMHG 17 Feb 2003
#define Module_MajorVersion "1.00"
#define Module_Version 100
#define Module_MinorVersion ""
#define Module_Date "17 Feb 2003"
#define Module_ApplicationDate "17-Feb-03"
#define Module_ComponentName "SoundCtrl"
#define Module_ComponentPath "RiscOS/Sources/Audio/SoundCtrl"
#define Module_FullVersion "1.00"
#define Module_HelpVersion "1.00 (17 Feb 2003)"
#define Module_LibraryVersionInfo "1:00"
c/global 0 → 100644
View file @ ead37e6a
/* Copyright 2003 Tematic Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*****************************************************************************
* $Id$
* $Name$
*
* Author(s): Ben Avison
* Project(s): Tungsten
*
* ----------------------------------------------------------------------------
* Purpose: Main relocatable module entry points
*
* ----------------------------------------------------------------------------
* History: See source control system log
*
*****************************************************************************/
/*****************************************************************************
* Include header files
*****************************************************************************/
#include "global.h"
/*****************************************************************************
* MACROS
*****************************************************************************/
/*****************************************************************************
* New type definitions
*****************************************************************************/
/*****************************************************************************
* Constants
*****************************************************************************/
/*****************************************************************************
* File scope Global variables
*****************************************************************************/
MessagesFD global_MessageFD; /* message file descriptor */
/*****************************************************************************
* Function prototypes - Private to this file
*****************************************************************************/
/*****************************************************************************
* Functions
*****************************************************************************/
/*****************************************************************************
* END OF FILE
*****************************************************************************/
c/mess 0 → 100644
View file @ ead37e6a
/* Copyright 2003 Tematic Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*****************************************************************************
* $Id$
* $Name$
*
* Author(s): Ben Avison
* Project(s): Tungsten
*
* ----------------------------------------------------------------------------
* Purpose: Message lookup and error handling routines
*
* ----------------------------------------------------------------------------
* History: See source control system log
*
*****************************************************************************/
/*****************************************************************************
* Include header files
*****************************************************************************/
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include "swis.h"
#include "global.h"
#include "mess.h"
/*****************************************************************************
* MACROS
*****************************************************************************/
/*****************************************************************************
* New type definitions
*****************************************************************************/
/*****************************************************************************
* Constants
*****************************************************************************/
/*****************************************************************************
* File scope Global variables
*****************************************************************************/
static _kernel_oserror static_ErrorBlockIn = { 0, "" };
static _kernel_oserror static_ErrorBlockOut = { 0, "" };
static char static_LookedUpText[256];
/*****************************************************************************
* Function prototypes - Private to this file
*****************************************************************************/
/*****************************************************************************
* Functions
*****************************************************************************/
/*****************************************************************************
* mess_GenerateError
*
* Builds an error block from a message file token
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* token: pointer to token
* errno: error number
* nparams: parameter count
* ...: between 0 and 4 (const char *) parameter pointers
*
* Outputs
* NONE
*
* Returns
* pointer to error block
*****************************************************************************/
_kernel_oserror *mess_GenerateError(const char *token, uint32_t errno, size_t nparams, ...)
{
va_list ap;
const char *p[4] = { NULL, NULL, NULL, NULL };
size_t i;
/* Set up tokenised error block */
static_ErrorBlockIn.errnum = errno;
strncpy((char *) &(static_ErrorBlockIn.errmess),
token, sizeof(static_ErrorBlockIn.errmess));
/* Determine parameter pointers */
va_start(ap,nparams);
nparams = MIN(nparams,4);
for (i = 0; i < nparams; ++i)
{
p[i] = va_arg(ap,const char *);
}
va_end(ap);
/* Look up token using our buffer */
return _swix(MessageTrans_ErrorLookup, _INR(0,7),
&static_ErrorBlockIn,
&global_MessageFD,
&static_ErrorBlockOut,
sizeof(static_ErrorBlockOut),
p[0],
p[1],
p[2],
p[3]);
}
/*****************************************************************************
* mess_MakeError
*
* Builds an error block, generating the message token from the error number
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* errno: error number
* nparams: parameter count
* ...: between 0 and 4 (const char *) parameter pointers
*
* Outputs
* NONE
*
* Returns
* pointer to error block
*****************************************************************************/
_kernel_oserror *mess_MakeError(uint32_t errno, size_t nparams, ...)
{
va_list ap;
const char *p[4] = { NULL, NULL, NULL, NULL };
size_t i;
/* Set up tokenised error block */
static_ErrorBlockIn.errnum = errno;
sprintf(static_ErrorBlockIn.errmess, "E%02X", errno & 0xFF);
/* Determine parameter pointers */
va_start(ap,nparams);
nparams = MIN(nparams,4);
for (i = 0; i < nparams; ++i)
{
p[i] = va_arg(ap,const char *);
}
va_end(ap);
/* Look up token using our buffer */
return _swix(MessageTrans_ErrorLookup, _INR(0,7),
&static_ErrorBlockIn,
&global_MessageFD,
&static_ErrorBlockOut,
sizeof(static_ErrorBlockOut),
p[0],
p[1],
p[2],
p[3]);
}
/*****************************************************************************
* mess_CacheError
*
* Copies an error block where it won't be trampled on by MessageTrans
*
* Assumptions
* NONE
*
* Inputs
* err_in: pointer to MessageTrans error block
*
* Outputs
* NONE
*
* Returns
* pointer to static error block
*****************************************************************************/
_kernel_oserror *mess_CacheError(const _kernel_oserror *err_in)
{
if (err_in != NULL)
{
static_ErrorBlockOut.errnum = err_in->errnum;
strncpy(&static_ErrorBlockOut.errmess[0],
&err_in->errmess[0], sizeof(static_ErrorBlockOut.errmess));
}
return (err_in ? &static_ErrorBlockOut : NULL);
}
/*****************************************************************************
* mess_LookUp
*
* Looks up text from a message file token
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* token: pointer to token (0, 10 or 13 terminated)
* nparams: parameter count
* ...: between 0 and 4 (const char *) parameter pointers
*
* Outputs
* result_ptr: filled in with pointer to (volatile) result string
*
* Returns
* NULL if successful; otherwise pointer to error block
*****************************************************************************/
_kernel_oserror *mess_LookUp(const char *token, const char **result_ptr, size_t nparams, ...)
{
va_list ap;
const char *p[4] = { NULL, NULL, NULL, NULL };
size_t i;
/* Determine parameter pointers */
va_start(ap,nparams);
nparams = MIN(nparams,4);
for (i = 0; i < nparams; ++i)
{
p[i] = va_arg(ap,const char *);
}
va_end(ap);
/* Look up token using our buffer */
return _swix(MessageTrans_Lookup, _INR(0,7)|_OUT(2),
&global_MessageFD,
token,
&static_LookedUpText,
sizeof(static_LookedUpText),
p[0],
p[1],
p[2],
p[3],
result_ptr);
}
/*****************************************************************************
* mess_LookUpDirect
*
* Finds the address of text associated with a token in MessageTrans' static
* copy of the messages file
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* token: pointer to token (0, 10 or 13 terminated)
*
* Outputs
* result_ptr: filled in with pointer to result string
* result_len: if nonzero, filled in with length of string
*
* Returns
* NULL if successful; otherwise pointer to error block
*****************************************************************************/
_kernel_oserror *mess_LookUpDirect(const char *token, const char **result_ptr, size_t *result_len)
{
if (result_len == NULL)
{
return _swix(MessageTrans_Lookup, _INR(0,2)|_OUT(2),
&global_MessageFD,
token,
0,
result_ptr);
}
else
{
return _swix(MessageTrans_Lookup, _INR(0,2)|_OUTR(2,3),
&global_MessageFD,
token,
0,
result_ptr,
result_len);
}
}
/*****************************************************************************
* mess_LookUpBuffer
*
* Looks up text from a message file token, using the supplied buffer
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* token: pointer to token (0, 10 or 13 terminated)
* buffer: pointer to buffer
* bufsize: size of buffer
* nparams: parameter count
* ...: between 0 and 4 (const char *) parameter pointers
*
* Outputs
* NONE
*
* Returns
* NULL if successful; otherwise pointer to error block
*****************************************************************************/
_kernel_oserror *mess_LookUpBuffer(const char *token, char *buffer, size_t bufsize, size_t nparams, ...)
{
va_list ap;
const char *p[4] = { NULL, NULL, NULL, NULL };
size_t i;
/* Determine parameter pointers */
va_start(ap,nparams);
nparams = MIN(nparams,4);
for (i = 0; i < nparams; ++i)
{
p[i] = va_arg(ap,const char *);
}
va_end(ap);
/* Look up token using our buffer */
return _swix(MessageTrans_Lookup, _INR(0,7),
&global_MessageFD,
token,
buffer,
bufsize,
p[0],
p[1],
p[2],
p[3]);
}
/*****************************************************************************
* END OF FILE
*****************************************************************************/
c/module 0 → 100644
View file @ ead37e6a
/* Copyright 2003 Tematic Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <stdlib.h>
#include <stdio.h>
#include <stdbool.h>
#include <stdint.h>
#include <inttypes.h>
#include "kernel.h"
#include "swis.h"
#include "Global/HALDevice.h"
#include "Global/Services.h"
#include "Interface/MixerDevice.h"
#include "DebugLib/DebugLib.h"
#include "global.h"
#include "mess.h"
#include "modhdr.h"
#include "resmess.h"
#define LAST_KNOWN_DEVICE_VERSION 0
typedef struct system
{
struct system *next;
uint32_t number;
struct mixer_device *device;
}
system_t;
static _kernel_oserror *GetInitialDevices(void);
static void RemoveAllDevices(void);
static void AddDevice(struct mixer_device *device);
static void RemoveDevice(struct mixer_device *device);
static void MixVolumeCommand(const char *arg_string, int argc);
static _kernel_oserror *ExamineMixerSWI(_kernel_swi_regs *r);
static _kernel_oserror *SetMixSWI(_kernel_swi_regs *r);
static _kernel_oserror *GetMixSWI(_kernel_swi_regs *r);
static _kernel_oserror *FindChannel(uint32_t system_num, int32_t category, uint32_t index, system_t **system, uint32_t *channel);
static _kernel_oserror *FindSystemBlock(uint32_t system_num, system_t **system);
static system_t *static_SystemList = NULL;
_kernel_oserror *module_Init(const char *cmd_tail, int podule_base, void *pw)
{
_kernel_oserror *e = NULL;
#ifndef ROM_MODULE
bool FileRegistered = false;
#endif
bool MessagesOpen = false;
bool DevicesEnumerated = false;
IGNORE(cmd_tail);
IGNORE(podule_base);
IGNORE(pw);
debug_initialise("SoundCtrl", "null:", "");
debug_atexit();
debug_set_taskname_prefix(false);
debug_set_area_level_prefix(true);
debug_set_area_pad_limit(0);
debug_set_device(HOSTFS_OUTPUT);
debug_set_raw_device(NULL_OUTPUT);
debug_set_trace_device(NULL_OUTPUT);
if (!e)
{
#ifndef ROM_MODULE
e = _swix(ResourceFS_RegisterFiles, _IN(0),
resmess_ResourcesFiles());
}
if (!e)
{
FileRegistered = true;
#endif
e = _swix(MessageTrans_OpenFile, _INR(0,2),
&global_MessageFD,
Module_MessagesFile,
0);
}
if (!e)
{
MessagesOpen = true;
e = GetInitialDevices();
}
if (!e)
{
DevicesEnumerated = true;
/* Add other initialisation here */
}
if (e && DevicesEnumerated) RemoveAllDevices();
if (e && MessagesOpen) _swix(MessageTrans_CloseFile, _IN(0),
&global_MessageFD);
#ifndef ROM_MODULE
if (e && FileRegistered) _swix(ResourceFS_DeregisterFiles, _IN(0),
resmess_ResourcesFiles());
#endif
return e;
}
_kernel_oserror *module_Final(int fatal, int podule, void *pw)
{
_kernel_oserror *e = NULL;
IGNORE(fatal);
IGNORE(podule);
IGNORE(pw);
if (!e)
{
RemoveAllDevices();
_swix(MessageTrans_CloseFile, _IN(0),
&global_MessageFD);
#ifndef ROM_MODULE
_swix(ResourceFS_DeregisterFiles, _IN(0),
resmess_ResourcesFiles());
#endif
}
return e;
}
void module_Service(int service_number, _kernel_swi_regs *r, void *pw)
{
IGNORE(pw);
switch (service_number)
{
case Service_Hardware:;
struct mixer_device *device = (struct mixer_device *) r->r[2];
switch (r->r[0] & 0xFF)
{
case 0:
if (!(device->device.version > LAST_KNOWN_DEVICE_VERSION))
{
AddDevice(device);
}
break;
case 1:
if (!(device->device.version > LAST_KNOWN_DEVICE_VERSION))
{
RemoveDevice(device);
}
break;
}
break;
}
return;
}
_kernel_oserror *module_Commands(const char *arg_string, int argc, int cmd_no, void *pw)
{
IGNORE(pw);
switch(cmd_no)
{
case CMD_MixVolume:
MixVolumeCommand(arg_string, argc);
break;
}
return NULL;
}
_kernel_oserror *module_SWI(int swi_offset, _kernel_swi_regs *r, void *pw)
{
_kernel_oserror *e;
IGNORE(pw);
switch(swi_offset)
{
case SoundCtrl_ExamineMixer - SoundCtrl_00:
e = ExamineMixerSWI(r);
break;
case SoundCtrl_SetMix - SoundCtrl_00:
e = SetMixSWI(r);
break;
case SoundCtrl_GetMix - SoundCtrl_00:
e = GetMixSWI(r);
break;
default:
e = mess_GenerateError("BadSWI", error_SOUNDCTRL_BAD_SWI, 1, "SoundControl");
break;
}
return e;
}
static _kernel_oserror *GetInitialDevices(void)
{
int32_t r1 = 0;
system_t *system = NULL;
do
{
_kernel_oserror *e;
struct mixer_device *device;
e = _swix(OS_Hardware, _INR(0,1)|_IN(8)|_OUTR(1,2),
(LAST_KNOWN_DEVICE_VERSION << 16) | HALDeviceType_Audio | HALDeviceAudio_Mixer,
r1,
4,
&r1,
&device);
if (!e && r1 == -1) break;
if (!e)
{
system = malloc(sizeof *system);
if (system == NULL) e = mess_GenerateError("NoMem", error_SOUNDCTRL_NO_MEM, 0);
}
if (e)
{
RemoveAllDevices();
return e;
}
if (device->device.Activate(&device->device))
{
system->next = static_SystemList;
system->device = device;
static_SystemList = system;
}
else
{
free(system);
}
}
while (true);
/* Now number the devices in the reverse of enumeration order */
/* so any motherboard mixer is guaranteed to get number 0 */
uint32_t counter = 0;
for (system = static_SystemList; system != NULL; system = system->next)
{
system->number = counter++;
}
return NULL;
}
static void RemoveAllDevices(void)
{
system_t *system = static_SystemList;
system_t *next;
for (; system != NULL; system = next)
{
next = system->next;
system->device->device.Deactivate(&system->device->device);
free(system);
}
return;
}
static void AddDevice(struct mixer_device *device)
{
system_t *system = malloc(sizeof *system);
if (system == NULL) return;
if (device->device.Activate(&device->device))
{
/* Seach for a gap in the list of system numbers; if a driver module was */
/* *RMReInited, this approach should hopefully keep the system number the same */
system_t *prev = NULL;
system_t *next = static_SystemList;
uint32_t expected_number = 0;
while (next != NULL && next->number == expected_number++)
{
prev = next;
next = next->next;
}
system->next = next;
if (prev)
{
prev->next = system;
}
else
{
static_SystemList = system;
}
}
else
{
free(system);
}
return;
}
static void RemoveDevice(struct mixer_device *device)
{
system_t *system = static_SystemList;
system_t *prev = NULL;
for (; system != NULL; prev = system, system = system->next)
{
if (system->device == device)
{
if (prev)
{
prev->next = system->next;
}
else
{
static_SystemList = system->next;
}
system->device->device.Deactivate(&system->device->device);
free(system);
break;
}
}
return;
}
static void MixVolumeCommand(const char *arg_string, int argc)
{
uint32_t system_num;
int32_t category;
uint32_t index;
unsigned char mute;
int32_t gain;
system_t *system;
uint32_t channel;
if (argc == 4)
{
if (sscanf(arg_string, "%"SCNu32" %"SCNd32" %"SCNu32" %c", &system_num, &category, &index, &mute) == 4)
{
mute -= '0';
if (mute <= 1 && FindChannel(system_num, category, index, &system, &channel) == 0)
{
struct mixer_device_channel_state state = system->device->GetMix(system->device, channel);
state.mute = mute;
system->device->SetMix(system->device, channel, state);
}
}
}
else /* argc == 5 */
{
if (sscanf(arg_string, "%"SCNu32" %"SCNd32" %"SCNu32" %c %"SCNd32, &system_num, &category, &index, &mute, &gain) == 5)
{
mute -= '0';
if (mute <= 1 && FindChannel(system_num, category, index, &system, &channel) == 0)
{
struct mixer_device_channel_state state = { mute, gain };
system->device->SetMix(system->device, channel, state);
}
}
}
return;
}
static _kernel_oserror *ExamineMixerSWI(_kernel_swi_regs *r)
{
system_t *system;
_kernel_oserror *e = FindSystemBlock((uint32_t) r->r[0], &system);
if (e) return e;
uint32_t nchannels = system->device->nchannels;
uint32_t to_do = r->r[2] / sizeof (struct mixer_device_channel_features);
if (to_do > nchannels) to_do = nchannels;
r->r[2] -= nchannels * sizeof (struct mixer_device_channel_features);
r->r[3] = sizeof (struct mixer_device_channel_features);
r->r[4] = to_do;
struct mixer_device_channel_features *ptr = (struct mixer_device_channel_features *) r->r[1];
for (uint32_t c = 0; c < to_do; c++)
{
*ptr++ = system->device->GetFeatures(system->device, c);
}
return e;
}
static _kernel_oserror *SetMixSWI(_kernel_swi_regs *r)
{
system_t *system;
uint32_t channel;
_kernel_oserror *e = FindChannel((uint32_t) r->r[0], (int32_t) r->r[1], (uint32_t) r->r[2], &system, &channel);
if (e) return e;
struct mixer_device_channel_state state = { r->r[3], r->r[4] };
system->device->SetMix(system->device, channel, state);
return e;
}
static _kernel_oserror *GetMixSWI(_kernel_swi_regs *r)
{
system_t *system;
uint32_t channel;
_kernel_oserror *e = FindChannel((uint32_t) r->r[0], (int32_t) r->r[1], (uint32_t) r->r[2], &system, &channel);
if (e) return e;
struct mixer_device_channel_state state = system->device->GetMix(system->device, channel);
r->r[3] = (int) state.mute;
r->r[4] = (int) state.gain;
return e;
}
static _kernel_oserror *FindChannel(uint32_t system_num, int32_t category, uint32_t index, system_t **system, uint32_t *channel)
{
_kernel_oserror *e = FindSystemBlock(system_num, system);
if (e) return e;
uint32_t c = 0;
uint32_t nchannels = (*system)->device->nchannels;
struct mixer_device_channel_features features;
for (; c < nchannels; c++)
{
features = (*system)->device->GetFeatures((*system)->device, c);
if (features.category == category && index-- == 0) /* note second isn't performed if first test fails */
{
*channel = c;
return NULL;
}
}
return mess_MakeError(error_SOUNDCTRL_BAD_CHANNEL, 0);
}
static _kernel_oserror *FindSystemBlock(uint32_t system_num, system_t **system)
{
system_t *s = static_SystemList;
for (; s != NULL; s = s->next)
{
if (s->number == system_num) break;
}
if (s)
{
*system = s;
return NULL;
}
else
{
return mess_MakeError(error_SOUNDCTRL_BAD_MIXER, 0);
}
}
cmhg/modhdr 0 → 100644
View file @ ead37e6a
; Copyright 2003 Tematic Ltd
;
; Licensed under the Apache License, Version 2.0 (the "License");
; you may not use this file except in compliance with the License.
; You may obtain a copy of the License at
;
; http://www.apache.org/licenses/LICENSE-2.0
;
; Unless required by applicable law or agreed to in writing, software
; distributed under the License is distributed on an "AS IS" BASIS,
; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
; See the License for the specific language governing permissions and
; limitations under the License.
;
#include "Global/Services.h"
#include "Global/SWIs.h"
#include "VersionNum"
initialisation-code: module_Init
finalisation-code: module_Final
service-call-handler: module_Service Service_Hardware
title-string: SoundControl
help-string: Sound_Control Module_MajorVersion_CMHG Module_MinorVersion_CMHG
date-string: Module_Date_CMHG
command-keyword-table: module_Commands MixVolume(,
min-args: 4,
max-args: 5,
international:,
invalid-syntax: "SSCTMXV",
help-text: "HSCTMXV"
)
swi-chunk-base-number: SoundCtrlSWI_Base
swi-handler-code: module_SWI
swi-decoding-table: SoundCtrlSWI_Name ExamineMixer,
SetMix,
GetMix
international-help-file:"Resources:$.Resources.SoundCtrl.Messages"
h/MixerDevice 0 → 100644
View file @ ead37e6a
/* Copyright 2003 Tematic Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef GLOBAL_MIXERDEVICE_H
#define GLOBAL_MIXERDEVICE_H
#pragma force_top_level
#pragma include_only_once
#include <stdbool.h>
#include <stdint.h>
#include "Global/HALDevice.h"
struct mixer_device_channel_features
{
bool fixed: 1;
bool mono: 1;
bool default_mute: 1;
unsigned : 13;
signed category: 16;
};
struct mixer_device_channel_state
{
bool mute: 1;
int32_t gain;
};
struct mixer_device
{
struct device device;
struct device *controller;
uint32_t nchannels;
struct mixer_device_channel_features (*GetFeatures)(struct mixer_device *, uint32_t channel);
void (*SetMix)(struct mixer_device *, uint32_t channel, struct mixer_device_channel_state state);
__value_in_regs struct mixer_device_channel_state (*GetMix)(struct mixer_device *, uint32_t channel);
};
enum
{
mixer_CATEGORY_SPEAKER = -1,
mixer_CATEGORY_HEADPHONES = -2,
mixer_CATEGORY_LINE_OUT = -3,
mixer_CATEGORY_AUX_OUT = -4,
mixer_CATEGORY_SYSTEM = 0,
mixer_CATEGORY_MIC = 1,
mixer_CATEGORY_LINE_IN = 2,
mixer_CATEGORY_AUX_IN = 3,
};
#endif
h/global 0 → 100644
View file @ ead37e6a
/* Copyright 2003 Tematic Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#if !defined(SOUNDCTRL_GLOBAL_H) /* file used if not already included */
#define SOUNDCTRL_GLOBAL_H
/*****************************************************************************
* $Id$
* $Name$
*
* Author(s): Ben Avison
* Project(s): Tungsten
*
* ----------------------------------------------------------------------------
* Purpose: Global variables
*
* ----------------------------------------------------------------------------
* History: See source control system log
*
*****************************************************************************/
/*****************************************************************************
* Include header files
*****************************************************************************/
#include "tboxlibs/toolbox.h"
#include "Global/NewErrors.h"
/*****************************************************************************
* MACROS
*****************************************************************************/
#ifndef IGNORE
#define IGNORE(x) { (x)=(x); }
#endif
#ifndef MIN
#define MIN(x,y) ((x)<(y)?(x):(y))
#endif
#ifndef MAX
#define MAX(x,y) ((x)>(y)?(x):(y))
#endif
#ifndef RETURN_ERROR
#define RETURN_ERROR(error_returning_statement) \
{ \
_kernel_oserror *returnerror_error = (error_returning_statement); \
if (returnerror_error != NULL) \
{ \
return returnerror_error; \
} \
}
#endif
/*****************************************************************************
* New type definitions
*****************************************************************************/
/*****************************************************************************
* Constants
*****************************************************************************/
enum
{
error_SOUNDCTRL_BAD_SWI = ErrorBase_SoundCtrl,
error_SOUNDCTRL_NO_MEM,
error_SOUNDCTRL_BAD_MIXER,
error_SOUNDCTRL_BAD_CHANNEL,
};
/*****************************************************************************
* Global variables
*****************************************************************************/
extern MessagesFD global_MessageFD; /* message file descriptor */
/*****************************************************************************
* Function prototypes
*****************************************************************************/
#endif /* end of sentry #ifdef */
/*****************************************************************************
* END OF FILE
*****************************************************************************/
h/mess 0 → 100644
View file @ ead37e6a
/* Copyright 2003 Tematic Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#if !defined(BAVISON_MESS_H) /* file used if not already included */
#define BAVISON_MESS_H
/*****************************************************************************
* $Id$
* $Name$
*
* Author(s): Ben Avison
* Project(s): Tungsten
*
* ----------------------------------------------------------------------------
* Purpose: Message lookup and error handling routines
*
* ----------------------------------------------------------------------------
* History: See source control system log
*
*****************************************************************************/
/*****************************************************************************
* Include header files
*****************************************************************************/
#include <stdint.h>
#include "kernel.h"
/*****************************************************************************
* MACROS
*****************************************************************************/
/*****************************************************************************
* New type definitions
*****************************************************************************/
/*****************************************************************************
* Constants
*****************************************************************************/
/*****************************************************************************
* Global variables
*****************************************************************************/
/*****************************************************************************
* Function prototypes
*****************************************************************************/
/*****************************************************************************
* mess_GenerateError
*
* Builds an error block from a message file token
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* token: pointer to token
* errno: error number
* nparams: parameter count
* ...: between 0 and 4 (const char *) parameter pointers
*
* Outputs
* NONE
*
* Returns
* pointer to error block
*****************************************************************************/
extern _kernel_oserror *mess_GenerateError(const char *token, uint32_t errno, size_t nparams, ...);
/*****************************************************************************
* mess_MakeError
*
* Builds an error block, generating the message token from the error number
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* errno: error number
* nparams: parameter count
* ...: between 0 and 4 (const char *) parameter pointers
*
* Outputs
* NONE
*
* Returns
* pointer to error block
*****************************************************************************/
extern _kernel_oserror *mess_MakeError(uint32_t errno, size_t nparams, ...);
/*****************************************************************************
* mess_CacheError
*
* Copies an error block where it won't be trampled on by MessageTrans
*
* Assumptions
* NONE
*
* Inputs
* err_in: pointer to MessageTrans error block
*
* Outputs
* NONE
*
* Returns
* pointer to static error block
*****************************************************************************/
extern _kernel_oserror *mess_CacheError(const _kernel_oserror *err_in);
/*****************************************************************************
* mess_LookUp
*
* Looks up text from a message file token
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* token: pointer to token (0, 10 or 13 terminated)
* nparams: parameter count
* ...: between 0 and 4 (const char *) parameter pointers
*
* Outputs
* result_ptr: filled in with pointer to (volatile) result string
*
* Returns
* NULL if successful; otherwise pointer to error block
*****************************************************************************/
extern _kernel_oserror *mess_LookUp(const char *token, const char **result_ptr, size_t nparams, ...);
/*****************************************************************************
* mess_LookUpDirect
*
* Finds the address of text associated with a token in MessageTrans' static
* copy of the messages file
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* token: pointer to token (0, 10 or 13 terminated)
*
* Outputs
* result_ptr: filled in with pointer to result string
* result_len: if nonzero, filled in with length of string
*
* Returns
* NULL if successful; otherwise pointer to error block
*****************************************************************************/
extern _kernel_oserror *mess_LookUpDirect(const char *token, const char **result_ptr, size_t *result_len);
/*****************************************************************************
* mess_LookUpBuffer
*
* Looks up text from a message file token, using the supplied buffer
*
* Assumptions
* global_MessageFD is valid
*
* Inputs
* token: pointer to token (0, 10 or 13 terminated)
* buffer: pointer to buffer
* bufsize: size of buffer
* nparams: parameter count
* ...: between 0 and 4 (const char *) parameter pointers
*
* Outputs
* NONE
*
* Returns
* NULL if successful; otherwise pointer to error block
*****************************************************************************/
extern _kernel_oserror *mess_LookUpBuffer(const char *token, char *buffer, size_t bufsize, size_t nparams, ...);
#endif /* end of sentry #ifdef */
/*****************************************************************************
* END OF FILE
*****************************************************************************/
h/resmess 0 → 100644
View file @ ead37e6a
/* Copyright 2003 Tematic Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#if !defined(RESMESS_H) /* file used if not already included */
#define RESMESS_H
/*****************************************************************************
* $Id$
* $Name$
*
* Author(s): Ben Avison
* Project(s): Ursula (originally)
*
* ----------------------------------------------------------------------------
* Purpose: Resource file embedding for RAM builds
*
* ----------------------------------------------------------------------------
* History: See source control system log
*
*****************************************************************************/
/*****************************************************************************
* Include header files
*****************************************************************************/
/*****************************************************************************
* MACROS
*****************************************************************************/
/*****************************************************************************
* New type definitions
*****************************************************************************/
/*****************************************************************************
* Constants
*****************************************************************************/
/*****************************************************************************
* Global variables
*****************************************************************************/
/*****************************************************************************
* Function prototypes
*****************************************************************************/
/*****************************************************************************
* resmess_ResourcesFiles
*
* Does nothing.
* Whatever you do, DON'T declare this as a variable and use its address -
* the ResGen documentation is wrong!
*
* Assumptions
* NONE
*
* Inputs
* NONE
*
* Outputs
* NONE
*
* Returns
* pointer to the resource file data within the image
*****************************************************************************/
extern void *resmess_ResourcesFiles(void);
#endif /* end of sentry #ifdef */
/*****************************************************************************
* END OF FILE
*****************************************************************************/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment