~ubuntu-branches/ubuntu/oneiric/oss4/oneiric-proposed

« back to all changes in this revision

Viewing changes to misc/man9ossddk/ossddk_dmap_get_buffused.9ossddk

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Rivera
  • Date: 2011-06-16 20:37:48 UTC
  • mfrom: (5.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110616203748-jbrxik6ql33z54co
Tags: 4.2-build2004-1ubuntu1
* Merge from Debian unstable.
  - Supports our current kernel (LP: #746048)
  Remaining changes:
  - debian/oss4-dkms.dkms.in: s/source/build/ in Kernel headers paths.
* ld-as-needed.patch: Re-order CC arguments to enable building with ld
  --as-needed (LP: #770972)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" te
 
2
.\"  Copyright (c) 2005, 4Front Technologies 2005\&.
 
3
.TH ossddk_dmap_get_buffused 9ossddk "12 Sep 2005" "SunOS 5.10" "OSS DDK Services"
 
4
.SH "NAME"
 
5
ossddk_dmap_get_buffused \- Returns the size of buffer that is actually in use
 
6
.PP
 
7
.SH "SYNOPSIS"
 
8
.nf
 
9
#include <sys/soundcard.h>
 
10
.LP
 
11
#include <sys/ossddk/ossddk.h>
 
12
.fi
 
13
.LP
 
14
\fBint\fR ossddk_dmap_get_buffused(\fBdmap_t *\fIdmap\fP);
 
15
.PP
 
16
.SH "INTERFACE LEVEL"
 
17
.PP
 
18
Open Sound System specific (OSS 4.0 DDK)\&.
 
19
.PP
 
20
.SH "ARGUMENTS"
 
21
.PP
 
22
.sp
 
23
.ne 2
 
24
.mk
 
25
\fB\fIdmap\fR
 
26
.in +16n
 
27
.rt
 
28
Audio buffer handle.
 
29
.in -16n
 
30
.PP
 
31
.SH "DESCRIPTION"
 
32
.PP
 
33
OSS audio devices have a DMA buffer with the maximum size returned by 
 
34
\fIossddk_dmap_get_buffsize\fR. However in most cases just part of the available
 
35
buffer is actually in use. The driver can call \fIossddk_dmap_get_buffused\fR
 
36
to find out the transfer count to be programmed in the device registers.
 
37
.PP
 
38
.SH "RETURN VALUES"
 
39
Amount of buffer currently in use (in bytes). This value equals to
 
40
fragment_size*num_fragments.
 
41
.PP
 
42
.SH "SEE ALSO"
 
43
.PP
 
44
\fIWriting Sound Device Drivers with OSS DDK\fR
 
45
.LP
 
46
\fIOpen Sound System Programmer's Guide\fR