AudioHardwareInterface.h
Go to the documentation of this file.00001 /* +00002 * Copyright (C) 2007 The Android Open Source Project +00003 * +00004 * Licensed under the Apache License, Version 2.0 (the "License"); +00005 * you may not use this file except in compliance with the License. +00006 * You may obtain a copy of the License at +00007 * +00008 * http://www.apache.org/licenses/LICENSE-2.0 +00009 * +00010 * Unless required by applicable law or agreed to in writing, software +00011 * distributed under the License is distributed on an "AS IS" BASIS, +00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +00013 * See the License for the specific language governing permissions and +00014 * limitations under the License. +00015 */ +00016 +00017 #ifndef ANDROID_AUDIO_HARDWARE_INTERFACE_H +00018 #define ANDROID_AUDIO_HARDWARE_INTERFACE_H +00019 +00020 #include <stdint.h> +00021 #include <sys/types.h> +00022 +00023 #include <utils/Errors.h> +00024 #include <utils/Vector.h> +00025 #include <utils/String16.h> +00026 +00027 #include <media/IAudioFlinger.h> +00028 #include "media/AudioSystem.h" +00029 +00030 +00031 namespace android { +00032 +00033 // ---------------------------------------------------------------------------- +00034 +00035 /** +00036 * AudioStreamOut is the abstraction interface for the audio output hardware. +00037 * +00038 * It provides information about various properties of the audio output hardware driver. +00039 */ +00040 class AudioStreamOut { +00041 public: +00042 virtual ~AudioStreamOut() = 0; +00043 +00044 /** return audio sampling rate in hz - eg. 44100 */ +00045 virtual uint32_t sampleRate() const = 0; +00046 +00047 /** returns size of output buffer - eg. 4800 */ +00048 virtual size_t bufferSize() const = 0; +00049 +00050 /** +00051 * return number of output audio channels. +00052 * Acceptable values are 1 (mono) or 2 (stereo) +00053 */ +00054 virtual int channelCount() const = 0; +00055 +00056 /** +00057 * return audio format in 8bit or 16bit PCM format - +00058 * eg. AudioSystem:PCM_16_BIT +00059 */ +00060 virtual int format() const = 0; +00061 +00062 /** +00063 * return the frame size (number of bytes per sample). +00064 */ +00065 uint32_t frameSize() const { return channelCount()*((format()==AudioSystem::PCM_16_BIT)?sizeof(int16_t):sizeof(int8_t)); } +00066 +00067 /** +00068 * return the audio hardware driver latency in milli seconds. +00069 */ +00070 virtual uint32_t latency() const = 0; +00071 +00072 /** +00073 * Use this method in situations where audio mixing is done in the +00074 * hardware. This method serves as a direct interface with hardware, +00075 * allowing you to directly set the volume as apposed to via the framework. +00076 * This method might produce multiple PCM outputs or hardware accelerated +00077 * codecs, such as MP3 or AAC. +00078 */ +00079 virtual status_t setVolume(float volume) = 0; +00080 +00081 /** write audio buffer to driver. Returns number of bytes written */ +00082 virtual ssize_t write(const void* buffer, size_t bytes) = 0; +00083 +00084 /** dump the state of the audio output device */ +00085 virtual status_t dump(int fd, const Vector<String16>& args) = 0; +00086 }; +00087 +00088 /** +00089 * AudioStreamIn is the abstraction interface for the audio input hardware. +00090 * +00091 * It defines the various properties of the audio hardware input driver. +00092 */ +00093 class AudioStreamIn { +00094 public: +00095 virtual ~AudioStreamIn() = 0; +00096 +00097 /** return the input buffer size allowed by audio driver */ +00098 virtual size_t bufferSize() const = 0; +00099 +00100 /** return the number of audio input channels */ +00101 virtual int channelCount() const = 0; +00102 +00103 /** +00104 * return audio format in 8bit or 16bit PCM format - +00105 * eg. AudioSystem:PCM_16_BIT +00106 */ +00107 virtual int format() const = 0; +00108 +00109 /** +00110 * return the frame size (number of bytes per sample). +00111 */ +00112 uint32_t frameSize() const { return channelCount()*((format()==AudioSystem::PCM_16_BIT)?sizeof(int16_t):sizeof(int8_t)); } +00113 +00114 /** set the input gain for the audio driver. This method is for +00115 * for future use */ +00116 virtual status_t setGain(float gain) = 0; +00117 +00118 /** read audio buffer in from audio driver */ +00119 virtual ssize_t read(void* buffer, ssize_t bytes) = 0; +00120 +00121 /** dump the state of the audio input device */ +00122 virtual status_t dump(int fd, const Vector<String16>& args) = 0; +00123 +00124 /** +00125 * Put the audio hardware input into standby mode. Returns +00126 * status based on include/utils/Errors.h +00127 */ +00128 virtual status_t standby() = 0; +00129 +00130 }; +00131 +00132 /** +00133 * AudioHardwareInterface.h defines the interface to the audio hardware abstraction layer. +00134 * +00135 * The interface supports setting and getting parameters, selecting audio routing +00136 * paths, and defining input and output streams. +00137 * +00138 * AudioFlinger initializes the audio hardware and immediately opens an output stream. +00139 * You can set Audio routing to output to handset, speaker, Bluetooth, or a headset. +00140 * +00141 * The audio input stream is initialized when AudioFlinger is called to carry out +00142 * a record operation. +00143 */ +00144 class AudioHardwareInterface +00145 { +00146 public: +00147 /** +00148 * check to see if the audio hardware interface has been initialized. +00149 * return status based on values defined in include/utils/Errors.h +00150 */ +00151 virtual status_t initCheck() = 0; +00152 +00153 /** +00154 * put the audio hardware into standby mode to conserve power. Returns +00155 * status based on include/utils/Errors.h +00156 */ +00157 virtual status_t standby() = 0; +00158 +00159 /** set the audio volume of a voice call. Range is between 0.0 and 1.0 */ +00160 virtual status_t setVoiceVolume(float volume) = 0; +00161 +00162 /** +00163 * set the audio volume for all audio activities other than voice call. +00164 * Range between 0.0 and 1.0. If any value other than NO_ERROR is returned, +00165 * the software mixer will emulate this capability. +00166 */ +00167 virtual status_t setMasterVolume(float volume) = 0; +00168 +00169 /** +00170 * Audio routing methods. Routes defined in include/hardware/AudioSystem.h. +00171 * Audio routes can be (ROUTE_EARPIECE | ROUTE_SPEAKER | ROUTE_BLUETOOTH +00172 * | ROUTE_HEADSET) +00173 * +00174 * setRouting sets the routes for a mode. This is called at startup. It is +00175 * also called when a new device is connected, such as a wired headset is +00176 * plugged in or a Bluetooth headset is paired. +00177 */ +00178 virtual status_t setRouting(int mode, uint32_t routes) = 0; +00179 +00180 virtual status_t getRouting(int mode, uint32_t* routes) = 0; +00181 +00182 /** +00183 * setMode is called when the audio mode changes. NORMAL mode is for +00184 * standard audio playback, RINGTONE when a ringtone is playing, and IN_CALL +00185 * when a call is in progress. +00186 */ +00187 virtual status_t setMode(int mode) = 0; +00188 virtual status_t getMode(int* mode) = 0; +00189 +00190 // mic mute +00191 virtual status_t setMicMute(bool state) = 0; +00192 virtual status_t getMicMute(bool* state) = 0; +00193 +00194 // Temporary interface, do not use +00195 // TODO: Replace with a more generic key:value get/set mechanism +00196 virtual status_t setParameter(const char* key, const char* value) = 0; +00197 +00198 // Returns audio input buffer size according to parameters passed or 0 if one of the +00199 // parameters is not supported +00200 virtual size_t getInputBufferSize(uint32_t sampleRate, int format, int channelCount) = 0; +00201 +00202 /** This method creates and opens the audio hardware output stream */ +00203 virtual AudioStreamOut* openOutputStream( +00204 int format=0, +00205 int channelCount=0, +00206 uint32_t sampleRate=0, +00207 status_t *status=0) = 0; +00208 +00209 /** This method creates and opens the audio hardware input stream */ +00210 virtual AudioStreamIn* openInputStream( +00211 int format, +00212 int channelCount, +00213 uint32_t sampleRate, +00214 status_t *status) = 0; +00215 +00216 /**This method dumps the state of the audio hardware */ +00217 virtual status_t dumpState(int fd, const Vector<String16>& args) = 0; +00218 +00219 static AudioHardwareInterface* create(); +00220 +00221 protected: +00222 /** +00223 * doRouting actually initiates the routing. A call to setRouting +00224 * or setMode may result in a routing change. The generic logic calls +00225 * doRouting when required. If the device has any special requirements these +00226 * methods can be overriden. +00227 */ +00228 virtual status_t doRouting() = 0; +00229 +00230 virtual status_t dump(int fd, const Vector<String16>& args) = 0; +00231 }; +00232 +00233 // ---------------------------------------------------------------------------- +00234 +00235 extern "C" AudioHardwareInterface* createAudioHardware(void); +00236 +00237 }; // namespace android +00238 +00239 #endif // ANDROID_AUDIO_HARDWARE_INTERFACE_H +
+
+
+
+
+
diff --git a/pdk/docs/_camera_hardware_interface_8h-source.html b/pdk/docs/_camera_hardware_interface_8h-source.html
new file mode 100755
index 000000000..41f0a1df3
--- /dev/null
+++ b/pdk/docs/_camera_hardware_interface_8h-source.html
@@ -0,0 +1,179 @@
+
+
+
+
+AudioHardwareInterface.h File Reference
++Go to the source code of this file.
Namespaces | |
| namespace | android |
Data Structures | |
| class | android::AudioStreamOut |
| AudioStreamOut is the abstraction interface for the audio output hardware. More... | |
| class | android::AudioStreamIn |
| AudioStreamIn is the abstraction interface for the audio input hardware. More... | |
| class | android::AudioHardwareInterface |
| AudioHardwareInterface.h defines the interface to the audio hardware abstraction layer. More... | |
Functions | |
| AudioHardwareInterface * | android::createAudioHardware (void) |
CameraHardwareInterface.h
Go to the documentation of this file.00001 /* +00002 * Copyright (C) 2008 The Android Open Source Project +00003 * +00004 * Licensed under the Apache License, Version 2.0 (the "License"); +00005 * you may not use this file except in compliance with the License. +00006 * You may obtain a copy of the License at +00007 * +00008 * http://www.apache.org/licenses/LICENSE-2.0 +00009 * +00010 * Unless required by applicable law or agreed to in writing, software +00011 * distributed under the License is distributed on an "AS IS" BASIS, +00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +00013 * See the License for the specific language governing permissions and +00014 * limitations under the License. +00015 */ +00016 +00017 #ifndef ANDROID_HARDWARE_CAMERA_HARDWARE_INTERFACE_H +00018 #define ANDROID_HARDWARE_CAMERA_HARDWARE_INTERFACE_H +00019 +00020 #include <utils/IMemory.h> +00021 #include <utils/RefBase.h> +00022 #include <ui/CameraParameters.h> +00023 +00024 namespace android { +00025 +00026 /** Callback for startPreview() */ +00027 typedef void (*preview_callback)(const sp<IMemory>& mem, void* user); +00028 +00029 /** Callback for takePicture() */ +00030 typedef void (*shutter_callback)(void* user); +00031 +00032 /** Callback for takePicture() */ +00033 typedef void (*raw_callback)(const sp<IMemory>& mem, void* user); +00034 +00035 /** Callback for takePicture() */ +00036 typedef void (*jpeg_callback)(const sp<IMemory>& mem, void* user); +00037 +00038 /** Callback for autoFocus() */ +00039 typedef void (*autofocus_callback)(bool focused, void* user); +00040 +00041 /** +00042 * CameraHardwareInterface.h defines the interface to the +00043 * camera hardware abstraction layer, used for setting and getting +00044 * parameters, live previewing, and taking pictures. +00045 * +00046 * It is a referenced counted interface with RefBase as its base class. +00047 * CameraService calls openCameraHardware() to retrieve a strong pointer to the +00048 * instance of this interface and may be called multiple times. The +00049 * following steps describe a typical sequence: +00050 * +00051 * -# After CameraService calls openCameraHardware(), getParameters() and +00052 * setParameters() are used to initialize the camera instance. +00053 * CameraService calls getPreviewHeap() to establish access to the +00054 * preview heap so it can be registered with SurfaceFlinger for +00055 * efficient display updating while in preview mode. +00056 * -# startPreview() is called, which is passed a preview_callback() +00057 * function and a user parameter. The camera instance then periodically +00058 * calls preview_callback() each time a new preview frame is available. +00059 * The callback routine has two parameters: the first is a pointer to +00060 * the IMemory containing the frame and the second a user parameter. If +00061 * the preview_callback code needs to use this memory after returning, +00062 * it must copy the data. +00063 * +00064 * Prior to taking a picture, CameraService calls autofocus() with +00065 * autofocus_callback() and a user parameter. When auto focusing has +00066 * completed, the camera instance calls autofocus_callback(), which informs +00067 * the application whether focusing was successful. The camera instance +00068 * only calls autofocus_callback() once and it is up to the application to +00069 * call autoFocus() again if refocusing is desired. +00070 * +00071 * CameraService calls takePicture() to request the camera instance take a +00072 * picture. This method has two callbacks: raw_callback() and jpeg_callback(). +00073 * When the raw image is available, raw_callback() is called with a pointer +00074 * to the IMemory containing the raw image. When the jpeg image is available, +00075 * jpeg_callback() is called with a pointer to the IMemory containing the +00076 * jpeg image. As with preview_callback(), the memory must be copied if it's +00077 * needed after returning. +00078 */ +00079 class CameraHardwareInterface : public virtual RefBase { +00080 public: +00081 virtual ~CameraHardwareInterface() { } +00082 +00083 /** Return the IMemoryHeap for the preview image heap */ +00084 virtual sp<IMemoryHeap> getPreviewHeap() const = 0; +00085 +00086 /** +00087 * Start preview mode. When a preview image is available +00088 * preview_callback is called with the user parameter. The +00089 * call back parameter may be null. +00090 */ +00091 virtual status_t startPreview(preview_callback cb, void* user) = 0; +00092 +00093 /** +00094 * Stop a previously started preview. +00095 */ +00096 virtual void stopPreview() = 0; +00097 +00098 /** +00099 * Start auto focus, the callback routine is called +00100 * once when focusing is complete. autoFocus() will +00101 * be called again if another auto focus is needed. +00102 */ +00103 virtual status_t autoFocus(autofocus_callback, +00104 void* user) = 0; +00105 +00106 /** +00107 * Take a picture. The raw_callback is called when +00108 * the uncompressed image is available. The jpeg_callback +00109 * is called when the compressed image is available. These +00110 * call backs may be null. The user parameter is passed +00111 * to each of the call back routines. +00112 */ +00113 virtual status_t takePicture(shutter_callback, +00114 raw_callback, +00115 jpeg_callback, +00116 void* user) = 0; +00117 +00118 /** +00119 * Cancel a picture that was started with takePicture. You may cancel any +00120 * of the shutter, raw, or jpeg callbacks. Calling this method when no +00121 * picture is being taken is a no-op. +00122 */ +00123 virtual status_t cancelPicture(bool cancel_shutter, +00124 bool cancel_raw, +00125 bool cancel_jpeg) = 0; +00126 +00127 /** Set the camera parameters. */ +00128 virtual status_t setParameters(const CameraParameters& params) = 0; +00129 +00130 /** Return the camera parameters. */ +00131 virtual CameraParameters getParameters() const = 0; +00132 +00133 /** +00134 * Release the hardware resources owned by this object. Note that this is +00135 * *not* done in the destructor. +00136 */ +00137 virtual void release() = 0; +00138 +00139 /** +00140 * Dump state of the camera hardware +00141 */ +00142 virtual status_t dump(int fd, const Vector<String16>& args) const = 0; +00143 }; +00144 +00145 /** factory function to instantiate a camera hardware object */ +00146 extern "C" sp<CameraHardwareInterface> openCameraHardware(); +00147 +00148 }; // namespace android +00149 +00150 #endif +
+
+
+
+
+
diff --git a/pdk/docs/androidBluetooth.gif b/pdk/docs/androidBluetooth.gif
new file mode 100755
index 000000000..e62f5a8de
Binary files /dev/null and b/pdk/docs/androidBluetooth.gif differ
diff --git a/pdk/docs/androidBluetoothProcessDiagram.jpg b/pdk/docs/androidBluetoothProcessDiagram.jpg
new file mode 100755
index 000000000..687218018
Binary files /dev/null and b/pdk/docs/androidBluetoothProcessDiagram.jpg differ
diff --git a/pdk/docs/androidCameraArchitecture.gif b/pdk/docs/androidCameraArchitecture.gif
new file mode 100755
index 000000000..2679b439a
Binary files /dev/null and b/pdk/docs/androidCameraArchitecture.gif differ
diff --git a/pdk/docs/annotated.html b/pdk/docs/annotated.html
new file mode 100755
index 000000000..c8ea2e2d7
--- /dev/null
+++ b/pdk/docs/annotated.html
@@ -0,0 +1,51 @@
+
+
+
+
+CameraHardwareInterface.h File Reference
++Go to the source code of this file.
Namespaces | |
| namespace | android |
Data Structures | |
| class | android::CameraHardwareInterface |
| CameraHardwareInterface.h defines the interface to the camera hardware abstraction layer, used for setting and getting parameters, live previewing, and taking pictures. More... | |
Typedefs | |
| typedef void(* | android::preview_callback )(const sp< IMemory > &mem, void *user) |
| Callback for startPreview(). | |
| typedef void(* | android::shutter_callback )(void *user) |
| Callback for takePicture(). | |
| typedef void(* | android::raw_callback )(const sp< IMemory > &mem, void *user) |
| Callback for takePicture(). | |
| typedef void(* | android::jpeg_callback )(const sp< IMemory > &mem, void *user) |
| Callback for takePicture(). | |
| typedef void(* | android::autofocus_callback )(bool focused, void *user) |
| Callback for autoFocus(). | |
Functions | |
| sp< CameraHardwareInterface > | android::openCameraHardware () |
| factory function to instantiate a camera hardware object | |
+
+
+
+
+
diff --git a/pdk/docs/audio_sub_system.html b/pdk/docs/audio_sub_system.html
index 8f72e3879..e0cf2173d 100755
--- a/pdk/docs/audio_sub_system.html
+++ b/pdk/docs/audio_sub_system.html
@@ -2,11 +2,23 @@
-Data Structures
Here are the data structures with brief descriptions:| android::AudioHardwareInterface | AudioHardwareInterface.h defines the interface to the audio hardware abstraction layer |
| android::AudioStreamIn | AudioStreamIn is the abstraction interface for the audio input hardware |
| android::AudioStreamOut | AudioStreamOut is the abstraction interface for the audio output hardware |
| android::CameraHardwareInterface | CameraHardwareInterface.h defines the interface to the camera hardware abstraction layer, used for setting and getting parameters, live previewing, and taking pictures |
| GpsCallbacks | GPS callback structure |
| GpsInterface | Represents the standard GPS interface |
| GpsLocation | Represents a location |
| GpsStatus | Represents the status |
| GpsSuplInterface | Extended interface for SUPL support |
| GpsSvInfo | Represents SV information |
| GpsSvStatus | Represents SV status |
| GpsXtraCallbacks | Callback structure for the XTRA interface |
| GpsXtraInterface | Extended interface for XTRA support |
+
@@ -91,19 +109,18 @@ h1,h2,h3 {
+Interface
Documentation
- Introduction +
- Dev Environment Setup
- Basic Bring up
+
- Building New Device
- Bring up @@ -111,26 +128,39 @@ h1,h2,h3 {
- Display Drivers
+
- Multimedia
-
-
- Audio Subsystem +
- Audio +
- Camera
- Power Management + + +
- Networking + + +
- Telephony
- Testing +
+Interface
Introduction
-Android provides two native layers that handle audio software:
-- Audio Flinger: the audio software implementation that provides the minimum required audio functions (as illustrated in the diagram below). -
- AudioHardwareInterface: the hardware abstraction layer that hides driver-specific audio implementations from the Android platform. -
AudioHardwareInterface serves as the glue between proprietary audio drivers and the Android AudioFlinger service, the core audio service that handles all audio-related requests from applications.
Porting Android to other Audio Stacks
+Building an Audio Library
-Porting Android to other audio stacks (OSS, ALSA, proprietary user-space audio libraries, etc.) requires inheriting from and modifying AudioHardwareInterface to support the driver-specific implementation.
To implement an audio driver, create a shared library that implements the interface defined in AudioHardwareInterface.h. You must name your shared library libaudio.so so that it will get loaded from /system/lib at runtime. Place libaudio sources and Android.mk in partner/acme/chipset_or_board/libaudio/.
The following stub Android.mk file ensures that libaudio compiles and links to the appropriate libraries:
AudioHardwareInterface Abstract Class
- -AudioHardwareInterface (//device/servers/audio/flinger) contains several pure virtual functions that the audio driver class being ported needs to implement.
Modifying AudioHardwareInterface
- -Once the audio driver that inherits AudioHardwareInterface is ready, modify the static function AudioHardwareInterface::create() in order to link/load the driver in Android.
Assume the manufacturer audio driver inherits from AudioHarddwareInterface and that it is compiled into a native shared library (libaudio.so). In this case, use dlopen to load the library.
You can find an example of a similar implementation in //device/libs/media/mediaplayer.cpp. (Note that the example below uses libpv.so because this is a real code snippet from mediaplayer.cpp. If your native shared library is called libaudio.so, replace libpv.so with your libaudio.so.)
-
-// load PV library and create PV player
-mLibHandle = dlopen("libpv.so", RTLD_NOW);
-if (!mLibHandle) {
- LOGE("dlopen failed on libpv.so\n");
- return UNKNOWN_ERROR;
-}
-createPlayer_f createPlayer = reinterpret_cast(dlsym(mLibHandle, "createPlayer"));
-if (!createPlayer) {
- LOGE("dlsym failed on createPlayer in libpv.so\n");
- return UNKNOWN_ERROR;
-}
-
-Load the libraries with a call from AudioHardwareInterface::create(), as illustrated below (full code found in //device/servers/audioflinger).
-if (property_get("ro.kernel.qemu", value, 0)) {
- LOGD("Running in emulation - using generic audio driver");
- hw = new AudioHardwareGeneric();
-}
-else {
- // Insert calling of dynamic loading of driver here...
-}
-if (hw->initCheck() != NO_ERROR) {
- LOGW("Using stubbed audio hardware. No sound will be produced.");
- delete hw;
- hw = new AudioHardwareStub();
-}
+LOCAL_PATH := $(call my-dir)
+include $(CLEAR_VARS)
+
+LOCAL_MODULE := libaudio
+
+LOCAL_SHARED_LIBRARIES := \
+ libcutils \
+ libutils \
+ libmedia \
+ libhardware
+
+LOCAL_SRC_FILES += MyAudioHardware.cpp
+
+LOCAL_CFLAGS +=
+
+LOCAL_C_INCLUDES +=
+
+LOCAL_STATIC_LIBRARIES += libaudiointerface
+
+include $(BUILD_SHARED_LIBRARY)
+Interface
+ + + +Note: This document relies on some Doxygen-generated content that appears in an iFrame below. To return to the Doxygen default content for this page, click here.
+ + + + +@@ -239,7 +255,7 @@ if (hw->initCheck() != NO_ERROR) { pageTracker._trackPageview(); } catch(e) {} -
v0.3 - 9 June 2008
+ v0.6 - 25 November 2008
diff --git a/pdk/docs/bluetooth.html b/pdk/docs/bluetooth.html
new file mode 100755
index 000000000..edd3c260d
--- /dev/null
+++ b/pdk/docs/bluetooth.html
@@ -0,0 +1,276 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
-
+
Documentation
+-
+
- Introduction + + + +
- Dev Environment Setup
+
-
+
- Build System +
+ - Basic Bring up + + + + +
- Multimedia + + +
- Power Management
+
+
-
+
- Power Management +
+
+ - Networking + + + +
- Telephony
+
-
+
- Radio Interface Layer + +
+ - Testing + + + +
+
+
+
+
+
+
+
+ Introduction
+ +Android's Bluetooth stack uses BlueZ version 3.36 for GAP, SDP, and RFCOMM profiles, and is a SIG-qualified Bluetooth 2.0 host stack.
+ +Bluez is GPL licensed, so the Android framework interacts with userspace bluez code through D-BUS IPC to avoid proprietary code.
+ +Headset and Handsfree (v1.5) profiles are implemented in the Android framework and are both tightly coupled with the Phone App. These profiles are also SIG qualified.
+ +The diagram below offers a library-oriented view of the Bluetooth stack. Click Bluetooth Process Diagram for a process-oriented view.
+ +
Porting
+ +BlueZ is Bluetooth 2.0 compatible and should work with any 2.0 chipset. There are two integration points:
+-
+
- UART driver +
- Bluetooth Power On / Off +
UART Driver
+ +The BlueZ kernel sub-system attaches to your hardware-specific UART driver using the hciattach daemon.
For example, for MSM7201A, this is drivers/serial/msm_serial.c. You may also need to edit command line options to hciattach via init.rc.
Bluetooth Power On / Off
+ +The method for powering on and off your bluetooth chip varies from Android V 1.0 to post 1.0.
+ +-
+
- 1.0: Android framework writes a 0 or 1 to
/sys/modules/board_[PLATFORM]/parameters/bluetooth_power_on.
+
+ - Post 1.0: Android framework uses the linux
rfkillAPI. Seearch/arm/mach-msm/board-trout-rfkill.cfor an example.
+
Tools
+ +BlueZ provides a rich set of command line tools for debugging and interacting with the Bluetooth sub-system, including:
+-
+
hciconfig
+hcitool
+hcidump
+sdptool
+dbus-send
+dbus-monitor
+
v0.6 - 25 November 2008
+
+
+
diff --git a/pdk/docs/bring_up.html b/pdk/docs/bring_up.html
index f53474a51..b70a35dd5 100755
--- a/pdk/docs/bring_up.html
+++ b/pdk/docs/bring_up.html
@@ -2,11 +2,23 @@
-
+
@@ -91,19 +109,18 @@ h1,h2,h3 {
Documentation
- Introduction +
- Dev Environment Setup
- Basic Bring up
+
- Building New Device
- Bring up @@ -111,26 +128,39 @@ h1,h2,h3 {
- Display Drivers
+
- Multimedia
-
-
- Audio Subsystem +
- Audio +
- Camera
- Power Management + + +
- Networking + + +
- Telephony
- Testing +
4. Burn Images to Flash
-### NEED HELP FINISHING THIS SECTION. KERNEL AND RAMDISK DON'T BELONG IN THIS LIST.
An image represents the state of a system or part of a system stored in non-volatile memory. The build process should produce the following system images:
- bootloader: The bootloader is a small program responsible for initiating loading of the operating system. @@ -526,7 +555,7 @@ service akmd /sbin/akmd pageTracker._trackPageview(); } catch(e) {} -
v0.3 - 9 June 2008
+ v0.6 - 25 November 2008
+
@@ -91,19 +109,18 @@ h1,h2,h3 {
Documentation
- Introduction +
- Dev Environment Setup
- Basic Bring up
+
- Building New Device
- Bring up @@ -111,26 +128,39 @@ h1,h2,h3 {
- Display Drivers
+
- Multimedia
-
-
- Audio Subsystem +
- Audio +
- Camera
- Power Management + + +
- Networking + + +
- Telephony
- Testing +
v0.3 - 9 June 2008
+ v0.6 - 25 November 2008
+
@@ -91,19 +109,18 @@ h1,h2,h3 {
Documentation
- Introduction +
- Dev Environment Setup
- Basic Bring up
+
- Building New Device
- Bring up @@ -111,26 +128,39 @@ h1,h2,h3 {
- Display Drivers
+
- Multimedia
-
-
- Audio Subsystem +
- Audio +
- Camera
- Power Management + + +
- Networking + + +
- Telephony
- Testing +
v0.3 - 9 June 2008
+ v0.6 - 25 November 2008
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
-
+
Documentation
+-
+
- Introduction + + + +
- Dev Environment Setup
+
-
+
- Build System +
+ - Basic Bring up + + + + +
- Multimedia + + +
- Power Management
+
+
-
+
- Power Management +
+
+ - Networking + + + +
- Telephony
+
-
+
- Radio Interface Layer + +
+ - Testing + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+ +Android's camera subsystem connects the camera application to the application framework and user space libraries, which in turn communicate with the camera hardware layer that operates the physical camera.
+The diagram below illustrates the structure of the camera subsystem.
+
Building a Camera Library
+ +To implement a camera driver, create a shared library that implements the interface defined in CameraHardwareInterface.h. You must name your shared library libcamera.so so that it will get loaded from /system/lib at runtime. Place libcamera sources and Android.mk in partner/acme/chipset_or_board/libcamera/.
The following stub Android.mk file ensures that libcamera compiles and links to the appropriate libraries:
+LOCAL_PATH := $(call my-dir) +include $(CLEAR_VARS) + +LOCAL_MODULE := libcamera + +LOCAL_SHARED_LIBRARIES := \ + libutils \ + librpc \ + liblog + +LOCAL_SRC_FILES += MyCameraHardware.cpp + +LOCAL_CFLAGS += + +LOCAL_C_INCLUDES += + +LOCAL_STATIC_LIBRARIES += \ + libcamera-common \ + libclock-rpc \ + libcommondefs-rpc + +include $(BUILD_SHARED_LIBRARY) ++ + +
Sequence Diagrams
+ + + +Preview
+ +The following diagram illustrates the sequence of function calls and actions necessary for your camera to preview.
+
+
+
+Taking a Picture
+ +The following diagram illustrates the sequence of function calls and actions necessary for your camera to take a picture.
+
+
+
+Interface
+ + + +Note: This document relies on some Doxygen-generated content that appears in an iFrame below. To return to the Doxygen default content for this page, click here.
+ + + + + + v0.6 - 25 November 2008
+
+
+
diff --git a/pdk/docs/cameraPreview.jpg b/pdk/docs/cameraPreview.jpg
new file mode 100755
index 000000000..3dea01174
Binary files /dev/null and b/pdk/docs/cameraPreview.jpg differ
diff --git a/pdk/docs/cameraTakePicture.jpg b/pdk/docs/cameraTakePicture.jpg
new file mode 100755
index 000000000..4ac6d953e
Binary files /dev/null and b/pdk/docs/cameraTakePicture.jpg differ
diff --git a/pdk/docs/classandroid_1_1_audio_hardware_interface.html b/pdk/docs/classandroid_1_1_audio_hardware_interface.html
new file mode 100755
index 000000000..d2e9ac884
--- /dev/null
+++ b/pdk/docs/classandroid_1_1_audio_hardware_interface.html
@@ -0,0 +1,584 @@
+
+
+
+
+
+
+
+
The documentation for this class was generated from the following file: +
+
+
diff --git a/pdk/docs/classandroid_1_1_audio_stream_in.html b/pdk/docs/classandroid_1_1_audio_stream_in.html
new file mode 100755
index 000000000..54391944a
--- /dev/null
+++ b/pdk/docs/classandroid_1_1_audio_stream_in.html
@@ -0,0 +1,292 @@
+
+
+
+
+android::AudioHardwareInterface Class Reference
AudioHardwareInterface.h defines the interface to the audio hardware abstraction layer. +More... +
+#include <AudioHardwareInterface.h>
+
+
Public Member Functions | |
| virtual status_t | initCheck ()=0 |
| check to see if the audio hardware interface has been initialized. | |
| virtual status_t | standby ()=0 |
| put the audio hardware into standby mode to conserve power. | |
| virtual status_t | setVoiceVolume (float volume)=0 |
| set the audio volume of a voice call. | |
| virtual status_t | setMasterVolume (float volume)=0 |
| set the audio volume for all audio activities other than voice call. | |
| virtual status_t | setRouting (int mode, uint32_t routes)=0 |
| Audio routing methods. | |
| virtual status_t | getRouting (int mode, uint32_t *routes)=0 |
| virtual status_t | setMode (int mode)=0 |
| setMode is called when the audio mode changes. | |
| virtual status_t | getMode (int *mode)=0 |
| virtual status_t | setMicMute (bool state)=0 |
| virtual status_t | getMicMute (bool *state)=0 |
| virtual status_t | setParameter (const char *key, const char *value)=0 |
| virtual size_t | getInputBufferSize (uint32_t sampleRate, int format, int channelCount)=0 |
| virtual AudioStreamOut * | openOutputStream (int format=0, int channelCount=0, uint32_t sampleRate=0, status_t *status=0)=0 |
| This method creates and opens the audio hardware output stream. | |
| virtual AudioStreamIn * | openInputStream (int format, int channelCount, uint32_t sampleRate, status_t *status)=0 |
| This method creates and opens the audio hardware input stream. | |
| virtual status_t | dumpState (int fd, const Vector< String16 > &args)=0 |
| This method dumps the state of the audio hardware. | |
Static Public Member Functions | |
| static AudioHardwareInterface * | create () |
Protected Member Functions | |
| virtual status_t | doRouting ()=0 |
| doRouting actually initiates the routing. | |
| virtual status_t | dump (int fd, const Vector< String16 > &args)=0 |
Detailed Description
+AudioHardwareInterface.h defines the interface to the audio hardware abstraction layer. ++The interface supports setting and getting parameters, selecting audio routing paths, and defining input and output streams.
+AudioFlinger initializes the audio hardware and immediately opens an output stream. You can set Audio routing to output to handset, speaker, Bluetooth, or a headset.
+The audio input stream is initialized when AudioFlinger is called to carry out a record operation. +
Definition at line 144 of file AudioHardwareInterface.h.
+Member Function Documentation
+ +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::initCheck | +( | ++ | ) | + [pure virtual] |
+
+
+
++check to see if the audio hardware interface has been initialized. +
+return status based on values defined in include/utils/Errors.h +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::standby | +( | ++ | ) | + [pure virtual] |
+
+
+
++put the audio hardware into standby mode to conserve power. +
+Returns status based on include/utils/Errors.h +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::setVoiceVolume | +( | +float | +volume | +) | + [pure virtual] |
+
+
+
++set the audio volume of a voice call. +
+Range is between 0.0 and 1.0 +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::setMasterVolume | +( | +float | +volume | +) | + [pure virtual] |
+
+
+
++set the audio volume for all audio activities other than voice call. +
+Range between 0.0 and 1.0. If any value other than NO_ERROR is returned, the software mixer will emulate this capability. +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::setRouting | +( | +int | +mode, | +|
| + | + | uint32_t | +routes | + |
| + | ) | + [pure virtual] |
+
+
+
++Audio routing methods. +
+Routes defined in include/hardware/AudioSystem.h. Audio routes can be (ROUTE_EARPIECE | ROUTE_SPEAKER | ROUTE_BLUETOOTH | ROUTE_HEADSET)
+setRouting sets the routes for a mode. This is called at startup. It is also called when a new device is connected, such as a wired headset is plugged in or a Bluetooth headset is paired. +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::getRouting | +( | +int | +mode, | +|
| + | + | uint32_t * | +routes | + |
| + | ) | + [pure virtual] |
+
+
+
++ +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::setMode | +( | +int | +mode | +) | + [pure virtual] |
+
+
+
++setMode is called when the audio mode changes. +
+NORMAL mode is for standard audio playback, RINGTONE when a ringtone is playing, and IN_CALL when a call is in progress. +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::getMode | +( | +int * | +mode | +) | + [pure virtual] |
+
+
+
++ +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::setMicMute | +( | +bool | +state | +) | + [pure virtual] |
+
+
+
++ +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::getMicMute | +( | +bool * | +state | +) | + [pure virtual] |
+
+
+
++ +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::setParameter | +( | +const char * | +key, | +|
| + | + | const char * | +value | + |
| + | ) | + [pure virtual] |
+
+
+
++ +
+
+
+
+
+| virtual size_t android::AudioHardwareInterface::getInputBufferSize | +( | +uint32_t | +sampleRate, | +|
| + | + | int | +format, | +|
| + | + | int | +channelCount | + |
| + | ) | + [pure virtual] |
+
+
+
++ +
+
+
+
+
+| virtual AudioStreamOut* android::AudioHardwareInterface::openOutputStream | +( | +int | + format = 0, |
+ |
| + | + | int | + channelCount = 0, |
+ |
| + | + | uint32_t | + sampleRate = 0, |
+ |
| + | + | status_t * | + status = 0 | + |
| + | ) | + [pure virtual] |
+
+
+
++This method creates and opens the audio hardware output stream. +
+ +
+
+
+
+
+| virtual AudioStreamIn* android::AudioHardwareInterface::openInputStream | +( | +int | +format, | +|
| + | + | int | +channelCount, | +|
| + | + | uint32_t | +sampleRate, | +|
| + | + | status_t * | +status | + |
| + | ) | + [pure virtual] |
+
+
+
++This method creates and opens the audio hardware input stream. +
+ +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::dumpState | +( | +int | +fd, | +|
| + | + | const Vector< String16 > & | +args | + |
| + | ) | + [pure virtual] |
+
+
+
++This method dumps the state of the audio hardware. +
+ +
+
+
+
+
+| static AudioHardwareInterface* android::AudioHardwareInterface::create | +( | ++ | ) | + [static] |
+
+
+
++ +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::doRouting | +( | ++ | ) | + [protected, pure virtual] |
+
+
+
++doRouting actually initiates the routing. +
+A call to setRouting or setMode may result in a routing change. The generic logic calls doRouting when required. If the device has any special requirements these methods can be overriden. +
+
+
+
+
+| virtual status_t android::AudioHardwareInterface::dump | +( | +int | +fd, | +|
| + | + | const Vector< String16 > & | +args | + |
| + | ) | + [protected, pure virtual] |
+
+
+
++ +
+
The documentation for this class was generated from the following file: +
+
+
+
The documentation for this class was generated from the following file: +
+
+
diff --git a/pdk/docs/classandroid_1_1_audio_stream_out.html b/pdk/docs/classandroid_1_1_audio_stream_out.html
new file mode 100755
index 000000000..5d727ee0b
--- /dev/null
+++ b/pdk/docs/classandroid_1_1_audio_stream_out.html
@@ -0,0 +1,316 @@
+
+
+
+
+android::AudioStreamIn Class Reference
AudioStreamIn is the abstraction interface for the audio input hardware. +More... +
+#include <AudioHardwareInterface.h>
+
+
Public Member Functions | |
| virtual | ~AudioStreamIn ()=0 |
| virtual size_t | bufferSize () const =0 |
| return the input buffer size allowed by audio driver | |
| virtual int | channelCount () const =0 |
| return the number of audio input channels | |
| virtual int | format () const =0 |
| return audio format in 8bit or 16bit PCM format - eg. | |
| uint32_t | frameSize () const |
| return the frame size (number of bytes per sample). | |
| virtual status_t | setGain (float gain)=0 |
| set the input gain for the audio driver. | |
| virtual ssize_t | read (void *buffer, ssize_t bytes)=0 |
| read audio buffer in from audio driver | |
| virtual status_t | dump (int fd, const Vector< String16 > &args)=0 |
| dump the state of the audio input device | |
| virtual status_t | standby ()=0 |
| Put the audio hardware input into standby mode. | |
Detailed Description
+AudioStreamIn is the abstraction interface for the audio input hardware. ++It defines the various properties of the audio hardware input driver. +
Definition at line 93 of file AudioHardwareInterface.h.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+| virtual android::AudioStreamIn::~AudioStreamIn | +( | ++ | ) | + [pure virtual] |
+
+
+
++ +
+
Member Function Documentation
+ +
+
+
+
+
+| virtual size_t android::AudioStreamIn::bufferSize | +( | ++ | ) | + const [pure virtual] |
+
+
+
++return the input buffer size allowed by audio driver +
+ +
+
+
+
+
+| virtual int android::AudioStreamIn::channelCount | +( | ++ | ) | + const [pure virtual] |
+
+
+
++return the number of audio input channels +
+ +
+
+
+
+
+| virtual int android::AudioStreamIn::format | +( | ++ | ) | + const [pure virtual] |
+
+
+
++return audio format in 8bit or 16bit PCM format - eg. +
+AudioSystem:PCM_16_BIT +
+
+
+
+
+| uint32_t android::AudioStreamIn::frameSize | +( | ++ | ) | + const [inline] |
+
+
+
++return the frame size (number of bytes per sample). +
+ +
Definition at line 112 of file AudioHardwareInterface.h.
+ +
+
+
+
+
+| virtual status_t android::AudioStreamIn::setGain | +( | +float | +gain | +) | + [pure virtual] |
+
+
+
++set the input gain for the audio driver. +
+This method is for for future use +
+
+
+
+
+| virtual ssize_t android::AudioStreamIn::read | +( | +void * | +buffer, | +|
| + | + | ssize_t | +bytes | + |
| + | ) | + [pure virtual] |
+
+
+
++read audio buffer in from audio driver +
+ +
+
+
+
+
+| virtual status_t android::AudioStreamIn::dump | +( | +int | +fd, | +|
| + | + | const Vector< String16 > & | +args | + |
| + | ) | + [pure virtual] |
+
+
+
++dump the state of the audio input device +
+ +
+
+
+
+
+| virtual status_t android::AudioStreamIn::standby | +( | ++ | ) | + [pure virtual] |
+
+
+
++Put the audio hardware input into standby mode. +
+Returns status based on include/utils/Errors.h +
+
The documentation for this class was generated from the following file: +
+
+
+
The documentation for this class was generated from the following file: +
+
+
diff --git a/pdk/docs/classandroid_1_1_camera_hardware_interface.html b/pdk/docs/classandroid_1_1_camera_hardware_interface.html
new file mode 100755
index 000000000..cddb82c31
--- /dev/null
+++ b/pdk/docs/classandroid_1_1_camera_hardware_interface.html
@@ -0,0 +1,393 @@
+
+
+
+
+android::AudioStreamOut Class Reference
AudioStreamOut is the abstraction interface for the audio output hardware. +More... +
+#include <AudioHardwareInterface.h>
+
+
Public Member Functions | |
| virtual | ~AudioStreamOut ()=0 |
| virtual uint32_t | sampleRate () const =0 |
| return audio sampling rate in hz - eg. | |
| virtual size_t | bufferSize () const =0 |
| returns size of output buffer - eg. | |
| virtual int | channelCount () const =0 |
| return number of output audio channels. | |
| virtual int | format () const =0 |
| return audio format in 8bit or 16bit PCM format - eg. | |
| uint32_t | frameSize () const |
| return the frame size (number of bytes per sample). | |
| virtual uint32_t | latency () const =0 |
| return the audio hardware driver latency in milli seconds. | |
| virtual status_t | setVolume (float volume)=0 |
| Use this method in situations where audio mixing is done in the hardware. | |
| virtual ssize_t | write (const void *buffer, size_t bytes)=0 |
| write audio buffer to driver. | |
| virtual status_t | dump (int fd, const Vector< String16 > &args)=0 |
| dump the state of the audio output device | |
Detailed Description
+AudioStreamOut is the abstraction interface for the audio output hardware. ++It provides information about various properties of the audio output hardware driver. +
Definition at line 40 of file AudioHardwareInterface.h.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+| virtual android::AudioStreamOut::~AudioStreamOut | +( | ++ | ) | + [pure virtual] |
+
+
+
++ +
+
Member Function Documentation
+ +
+
+
+
+
+| virtual uint32_t android::AudioStreamOut::sampleRate | +( | ++ | ) | + const [pure virtual] |
+
+
+
++return audio sampling rate in hz - eg. +
+44100 +
+
+
+
+
+| virtual size_t android::AudioStreamOut::bufferSize | +( | ++ | ) | + const [pure virtual] |
+
+
+
++returns size of output buffer - eg. +
+4800 +
+
+
+
+
+| virtual int android::AudioStreamOut::channelCount | +( | ++ | ) | + const [pure virtual] |
+
+
+
++return number of output audio channels. +
+Acceptable values are 1 (mono) or 2 (stereo) +
+
+
+
+
+| virtual int android::AudioStreamOut::format | +( | ++ | ) | + const [pure virtual] |
+
+
+
++return audio format in 8bit or 16bit PCM format - eg. +
+AudioSystem:PCM_16_BIT +
+
+
+
+
+| uint32_t android::AudioStreamOut::frameSize | +( | ++ | ) | + const [inline] |
+
+
+
++return the frame size (number of bytes per sample). +
+ +
Definition at line 65 of file AudioHardwareInterface.h.
+ +
+
+
+
+
+| virtual uint32_t android::AudioStreamOut::latency | +( | ++ | ) | + const [pure virtual] |
+
+
+
++return the audio hardware driver latency in milli seconds. +
+ +
+
+
+
+
+| virtual status_t android::AudioStreamOut::setVolume | +( | +float | +volume | +) | + [pure virtual] |
+
+
+
++Use this method in situations where audio mixing is done in the hardware. +
+This method serves as a direct interface with hardware, allowing you to directly set the volume as apposed to via the framework. This method might produce multiple PCM outputs or hardware accelerated codecs, such as MP3 or AAC. +
+
+
+
+
+| virtual ssize_t android::AudioStreamOut::write | +( | +const void * | +buffer, | +|
| + | + | size_t | +bytes | + |
| + | ) | + [pure virtual] |
+
+
+
++write audio buffer to driver. +
+Returns number of bytes written +
+
+
+
+
+| virtual status_t android::AudioStreamOut::dump | +( | +int | +fd, | +|
| + | + | const Vector< String16 > & | +args | + |
| + | ) | + [pure virtual] |
+
+
+
++dump the state of the audio output device +
+ +
+
The documentation for this class was generated from the following file: +
+
+
+
The documentation for this class was generated from the following file: +
+
+
diff --git a/pdk/docs/display_drivers.html b/pdk/docs/display_drivers.html
index eb4d31abf..c20afe547 100755
--- a/pdk/docs/display_drivers.html
+++ b/pdk/docs/display_drivers.html
@@ -2,11 +2,23 @@
-android::CameraHardwareInterface Class Reference
CameraHardwareInterface.h defines the interface to the camera hardware abstraction layer, used for setting and getting parameters, live previewing, and taking pictures. +More... +
+#include <CameraHardwareInterface.h>
+
+
Public Member Functions | |
| virtual | ~CameraHardwareInterface () |
| virtual sp< IMemoryHeap > | getPreviewHeap () const =0 |
| Return the IMemoryHeap for the preview image heap. | |
| virtual status_t | startPreview (preview_callback cb, void *user)=0 |
| Start preview mode. | |
| virtual void | stopPreview ()=0 |
| Stop a previously started preview. | |
| virtual status_t | autoFocus (autofocus_callback, void *user)=0 |
| Start auto focus, the callback routine is called once when focusing is complete. | |
| virtual status_t | takePicture (shutter_callback, raw_callback, jpeg_callback, void *user)=0 |
| Take a picture. | |
| virtual status_t | cancelPicture (bool cancel_shutter, bool cancel_raw, bool cancel_jpeg)=0 |
| Cancel a picture that was started with takePicture. | |
| virtual status_t | setParameters (const CameraParameters ¶ms)=0 |
| Set the camera parameters. | |
| virtual CameraParameters | getParameters () const =0 |
| Return the camera parameters. | |
| virtual void | release ()=0 |
| Release the hardware resources owned by this object. | |
| virtual status_t | dump (int fd, const Vector< String16 > &args) const =0 |
| Dump state of the camera hardware. | |
Detailed Description
+CameraHardwareInterface.h defines the interface to the camera hardware abstraction layer, used for setting and getting parameters, live previewing, and taking pictures. ++It is a referenced counted interface with RefBase as its base class. CameraService calls openCameraHardware() to retrieve a strong pointer to the instance of this interface and may be called multiple times. The following steps describe a typical sequence:
+
-
+
- After CameraService calls openCameraHardware(), getParameters() and setParameters() are used to initialize the camera instance. CameraService calls getPreviewHeap() to establish access to the preview heap so it can be registered with SurfaceFlinger for efficient display updating while in preview mode.
- startPreview() is called, which is passed a preview_callback() function and a user parameter. The camera instance then periodically calls preview_callback() each time a new preview frame is available. The callback routine has two parameters: the first is a pointer to the IMemory containing the frame and the second a user parameter. If the preview_callback code needs to use this memory after returning, it must copy the data.
+Prior to taking a picture, CameraService calls autofocus() with autofocus_callback() and a user parameter. When auto focusing has completed, the camera instance calls autofocus_callback(), which informs the application whether focusing was successful. The camera instance only calls autofocus_callback() once and it is up to the application to call autoFocus() again if refocusing is desired.
+CameraService calls takePicture() to request the camera instance take a picture. This method has two callbacks: raw_callback() and jpeg_callback(). When the raw image is available, raw_callback() is called with a pointer to the IMemory containing the raw image. When the jpeg image is available, jpeg_callback() is called with a pointer to the IMemory containing the jpeg image. As with preview_callback(), the memory must be copied if it's needed after returning. +
Definition at line 79 of file CameraHardwareInterface.h.
+Constructor & Destructor Documentation
+ +
+
+
+
+
+| virtual android::CameraHardwareInterface::~CameraHardwareInterface | +( | ++ | ) | + [inline, virtual] |
+
+
+
++ +
Definition at line 81 of file CameraHardwareInterface.h.
+ ++
Member Function Documentation
+ +
+
+
+
+
+| virtual sp<IMemoryHeap> android::CameraHardwareInterface::getPreviewHeap | +( | ++ | ) | + const [pure virtual] |
+
+
+
++Return the IMemoryHeap for the preview image heap. +
+ +
+
+
+
+
+| virtual status_t android::CameraHardwareInterface::startPreview | +( | +preview_callback | +cb, | +|
| + | + | void * | +user | + |
| + | ) | + [pure virtual] |
+
+
+
++Start preview mode. +
+When a preview image is available preview_callback is called with the user parameter. The call back parameter may be null. +
+
+
+
+
+| virtual void android::CameraHardwareInterface::stopPreview | +( | ++ | ) | + [pure virtual] |
+
+
+
++Stop a previously started preview. +
+ +
+
+
+
+
+| virtual status_t android::CameraHardwareInterface::autoFocus | +( | +autofocus_callback | +, | +|
| + | + | void * | +user | + |
| + | ) | + [pure virtual] |
+
+
+
++Start auto focus, the callback routine is called once when focusing is complete. +
+autoFocus() will be called again if another auto focus is needed. +
+
+
+
+
+| virtual status_t android::CameraHardwareInterface::takePicture | +( | +shutter_callback | +, | +|
| + | + | raw_callback | +, | +|
| + | + | jpeg_callback | +, | +|
| + | + | void * | +user | + |
| + | ) | + [pure virtual] |
+
+
+
++Take a picture. +
+The raw_callback is called when the uncompressed image is available. The jpeg_callback is called when the compressed image is available. These call backs may be null. The user parameter is passed to each of the call back routines. +
+
+
+
+
+| virtual status_t android::CameraHardwareInterface::cancelPicture | +( | +bool | +cancel_shutter, | +|
| + | + | bool | +cancel_raw, | +|
| + | + | bool | +cancel_jpeg | + |
| + | ) | + [pure virtual] |
+
+
+
++Cancel a picture that was started with takePicture. +
+You may cancel any of the shutter, raw, or jpeg callbacks. Calling this method when no picture is being taken is a no-op. +
+
+
+
+
+| virtual status_t android::CameraHardwareInterface::setParameters | +( | +const CameraParameters & | +params | +) | + [pure virtual] |
+
+
+
++Set the camera parameters. +
+ +
+
+
+
+
+| virtual CameraParameters android::CameraHardwareInterface::getParameters | +( | ++ | ) | + const [pure virtual] |
+
+
+
++Return the camera parameters. +
+ +
+
+
+
+
+| virtual void android::CameraHardwareInterface::release | +( | ++ | ) | + [pure virtual] |
+
+
+
++Release the hardware resources owned by this object. +
+Note that this is *not* done in the destructor. +
+
+
+
+
+| virtual status_t android::CameraHardwareInterface::dump | +( | +int | +fd, | +|
| + | + | const Vector< String16 > & | +args | + |
| + | ) | + const [pure virtual] |
+
+
+
++Dump state of the camera hardware. +
+ +
+
The documentation for this class was generated from the following file: +
+
@@ -91,19 +109,18 @@ h1,h2,h3 {
Documentation
- Introduction +
- Dev Environment Setup
- Basic Bring up
+
- Building New Device
- Bring up @@ -111,26 +128,39 @@ h1,h2,h3 {
- Display Drivers
+
- Multimedia
-
-
- Audio Subsystem +
- Audio +
- Camera
- Power Management + + +
- Networking + + +
- Telephony
- Testing +
v0.3 - 9 June 2008
+ v0.6 - 25 November 2008
+
+
+
+
+
diff --git a/pdk/docs/functions.html b/pdk/docs/functions.html
new file mode 100755
index 000000000..c31d517b6
--- /dev/null
+++ b/pdk/docs/functions.html
@@ -0,0 +1,258 @@
+
+
+
+
+File List
Here is a list of all files with brief descriptions:| AudioHardwareInterface.h [code] | |
| CameraHardwareInterface.h [code] | |
| gps.h [code] | |
| wifi.h [code] |
+Here is a list of all struct and union fields with links to the structures/unions they belong to:
+
+
+
diff --git a/pdk/docs/functions_func.html b/pdk/docs/functions_func.html
new file mode 100755
index 000000000..2d1c1dcc3
--- /dev/null
+++ b/pdk/docs/functions_func.html
@@ -0,0 +1,179 @@
+
+
+
+
++
- a -
-
+
- accuracy +: GpsLocation +
- almanac_mask +: GpsSvStatus +
- altitude +: GpsLocation +
- autoFocus() +: android::CameraHardwareInterface +
- azimuth +: GpsSvInfo +
- b -
-
+
- bearing +: GpsLocation +
- bufferSize() +: android::AudioStreamIn +, android::AudioStreamOut +
- c -
-
+
- cancelPicture() +: android::CameraHardwareInterface +
- channelCount() +: android::AudioStreamOut +, android::AudioStreamIn +
- cleanup +: GpsInterface +
- create() +: android::AudioHardwareInterface +
- d -
-
+
- delete_aiding_data +: GpsInterface +
- doRouting() +: android::AudioHardwareInterface +
- download_request_cb +: GpsXtraCallbacks +
- dump() +: android::AudioHardwareInterface +, android::AudioStreamIn +, android::AudioStreamOut +, android::CameraHardwareInterface +
- dumpState() +: android::AudioHardwareInterface +
- e -
-
+
- elevation +: GpsSvInfo +
- ephemeris_mask +: GpsSvStatus +
- f -
-
+
- flags +: GpsLocation +
- format() +: android::AudioStreamOut +, android::AudioStreamIn +
- frameSize() +: android::AudioStreamOut +, android::AudioStreamIn +
- g -
-
+
- get_extension +: GpsInterface +
- getInputBufferSize() +: android::AudioHardwareInterface +
- getMicMute() +: android::AudioHardwareInterface +
- getMode() +: android::AudioHardwareInterface +
- getParameters() +: android::CameraHardwareInterface +
- getPreviewHeap() +: android::CameraHardwareInterface +
- getRouting() +: android::AudioHardwareInterface +
- i -
-
+
- init +: GpsInterface +, GpsXtraInterface +
- initCheck() +: android::AudioHardwareInterface +
- inject_time +: GpsInterface +
- inject_xtra_data +: GpsXtraInterface +
- l -
-
+
- latency() +: android::AudioStreamOut +
- latitude +: GpsLocation +
- location_cb +: GpsCallbacks +
- longitude +: GpsLocation +
- n -
-
+
- num_svs +: GpsSvStatus +
- o -
-
+
- openInputStream() +: android::AudioHardwareInterface +
- openOutputStream() +: android::AudioHardwareInterface +
- p -
-
+
- prn +: GpsSvInfo +
- r -
-
+
- read() +: android::AudioStreamIn +
- release() +: android::CameraHardwareInterface +
- s -
-
+
- sampleRate() +: android::AudioStreamOut +
- set_apn +: GpsSuplInterface +
- set_fix_frequency +: GpsInterface +
- set_position_mode +: GpsInterface +
- setGain() +: android::AudioStreamIn +
- setMasterVolume() +: android::AudioHardwareInterface +
- setMicMute() +: android::AudioHardwareInterface +
- setMode() +: android::AudioHardwareInterface +
- setParameter() +: android::AudioHardwareInterface +
- setParameters() +: android::CameraHardwareInterface +
- setRouting() +: android::AudioHardwareInterface +
- setVoiceVolume() +: android::AudioHardwareInterface +
- setVolume() +: android::AudioStreamOut +
- snr +: GpsSvInfo +
- speed +: GpsLocation +
- standby() +: android::AudioStreamIn +, android::AudioHardwareInterface +
- start +: GpsInterface +
- startPreview() +: android::CameraHardwareInterface +
- status +: GpsStatus +
- status_cb +: GpsCallbacks +
- stop +: GpsInterface +
- stopPreview() +: android::CameraHardwareInterface +
- sv_list +: GpsSvStatus +
- sv_status_cb +: GpsCallbacks +
- t -
-
+
- takePicture() +: android::CameraHardwareInterface +
- timestamp +: GpsLocation +
- u -
-
+
- used_in_fix_mask +: GpsSvStatus +
- w -
-
+
- write() +: android::AudioStreamOut +
- ~ -
-
+
- ~AudioStreamIn() +: android::AudioStreamIn +
- ~AudioStreamOut() +: android::AudioStreamOut +
- ~CameraHardwareInterface() +: android::CameraHardwareInterface +
+
+
+
+
diff --git a/pdk/docs/functions_vars.html b/pdk/docs/functions_vars.html
new file mode 100755
index 000000000..6d4b71802
--- /dev/null
+++ b/pdk/docs/functions_vars.html
@@ -0,0 +1,158 @@
+
+
+
+
++
- a -
-
+
- autoFocus() +: android::CameraHardwareInterface +
- b -
-
+
- bufferSize() +: android::AudioStreamOut +, android::AudioStreamIn +
- c -
-
+
- cancelPicture() +: android::CameraHardwareInterface +
- channelCount() +: android::AudioStreamOut +, android::AudioStreamIn +
- create() +: android::AudioHardwareInterface +
- d -
-
+
- doRouting() +: android::AudioHardwareInterface +
- dump() +: android::AudioStreamOut +, android::CameraHardwareInterface +, android::AudioHardwareInterface +, android::AudioStreamIn +
- dumpState() +: android::AudioHardwareInterface +
- f -
-
+
- format() +: android::AudioStreamOut +, android::AudioStreamIn +
- frameSize() +: android::AudioStreamOut +, android::AudioStreamIn +
- g -
-
+
- getInputBufferSize() +: android::AudioHardwareInterface +
- getMicMute() +: android::AudioHardwareInterface +
- getMode() +: android::AudioHardwareInterface +
- getParameters() +: android::CameraHardwareInterface +
- getPreviewHeap() +: android::CameraHardwareInterface +
- getRouting() +: android::AudioHardwareInterface +
- i -
-
+
- initCheck() +: android::AudioHardwareInterface +
- l -
-
+
- latency() +: android::AudioStreamOut +
- o -
-
+
- openInputStream() +: android::AudioHardwareInterface +
- openOutputStream() +: android::AudioHardwareInterface +
- r -
-
+
- read() +: android::AudioStreamIn +
- release() +: android::CameraHardwareInterface +
- s -
-
+
- sampleRate() +: android::AudioStreamOut +
- setGain() +: android::AudioStreamIn +
- setMasterVolume() +: android::AudioHardwareInterface +
- setMicMute() +: android::AudioHardwareInterface +
- setMode() +: android::AudioHardwareInterface +
- setParameter() +: android::AudioHardwareInterface +
- setParameters() +: android::CameraHardwareInterface +
- setRouting() +: android::AudioHardwareInterface +
- setVoiceVolume() +: android::AudioHardwareInterface +
- setVolume() +: android::AudioStreamOut +
- standby() +: android::AudioHardwareInterface +, android::AudioStreamIn +
- startPreview() +: android::CameraHardwareInterface +
- stopPreview() +: android::CameraHardwareInterface +
- t -
-
+
- takePicture() +: android::CameraHardwareInterface +
- w -
-
+
- write() +: android::AudioStreamOut +
- ~ -
-
+
- ~AudioStreamIn() +: android::AudioStreamIn +
- ~AudioStreamOut() +: android::AudioStreamOut +
- ~CameraHardwareInterface() +: android::CameraHardwareInterface +
+
+
+
+
diff --git a/pdk/docs/getting_source_code.html b/pdk/docs/getting_source_code.html
index 49bfcb0ae..ad0cddbd4 100755
--- a/pdk/docs/getting_source_code.html
+++ b/pdk/docs/getting_source_code.html
@@ -2,11 +2,23 @@
-+
- a -
-
+
- accuracy +: GpsLocation +
- almanac_mask +: GpsSvStatus +
- altitude +: GpsLocation +
- azimuth +: GpsSvInfo +
- b -
-
+
- bearing +: GpsLocation +
- c -
-
+
- cleanup +: GpsInterface +
- d -
-
+
- delete_aiding_data +: GpsInterface +
- download_request_cb +: GpsXtraCallbacks +
- e -
-
+
- elevation +: GpsSvInfo +
- ephemeris_mask +: GpsSvStatus +
- f -
-
+
- flags +: GpsLocation +
- g -
-
+
- get_extension +: GpsInterface +
- i -
-
+
- init +: GpsInterface +, GpsXtraInterface +
- inject_time +: GpsInterface +
- inject_xtra_data +: GpsXtraInterface +
- l -
-
+
- latitude +: GpsLocation +
- location_cb +: GpsCallbacks +
- longitude +: GpsLocation +
- n -
-
+
- num_svs +: GpsSvStatus +
- p -
-
+
- prn +: GpsSvInfo +
- s -
-
+
- set_apn +: GpsSuplInterface +
- set_fix_frequency +: GpsInterface +
- set_position_mode +: GpsInterface +
- snr +: GpsSvInfo +
- speed +: GpsLocation +
- start +: GpsInterface +
- status +: GpsStatus +
- status_cb +: GpsCallbacks +
- stop +: GpsInterface +
- sv_list +: GpsSvStatus +
- sv_status_cb +: GpsCallbacks +
- t -
-
+
- timestamp +: GpsLocation +
- u -
-
+
- used_in_fix_mask +: GpsSvStatus +
+
@@ -91,6 +109,7 @@ h1,h2,h3 {
Documentation
- Introduction + @@ -98,12 +117,14 @@ h1,h2,h3 {
- Dev Environment Setup
- Basic Bring up
+
- Building New Device
- Bring up @@ -111,26 +132,39 @@ h1,h2,h3 {
- Display Drivers
+
- Multimedia
- Power Management + + +
- Networking + + +
- Telephony
- Testing +
v0.3 - 9 June 2008
+ v0.5 - 25 September 2008
+Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:
+
+
+
diff --git a/pdk/docs/globals_func.html b/pdk/docs/globals_func.html
new file mode 100755
index 000000000..436cbf7a6
--- /dev/null
+++ b/pdk/docs/globals_func.html
@@ -0,0 +1,73 @@
+
+
+
+
++
-
+
- do_dhcp_request() +: wifi.h +
- get_dhcp_error_string() +: wifi.h +
- gps_get_hardware_interface() +: gps.h +
- gps_get_interface() +: gps.h +
- gps_get_qemu_interface() +: gps.h +
- gps_location_callback +: gps.h +
- gps_status_callback +: gps.h +
- gps_sv_status_callback +: gps.h +
- gps_xtra_download_request +: gps.h +
- GpsAidingData +: gps.h +
- GpsLocationFlags +: gps.h +
- GpsPositionMode +: gps.h +
- GpsStatusValue +: gps.h +
- GpsUtcTime +: gps.h +
- wifi_close_supplicant_connection() +: wifi.h +
- wifi_command() +: wifi.h +
- wifi_connect_to_supplicant() +: wifi.h +
- wifi_load_driver() +: wifi.h +
- wifi_start_supplicant() +: wifi.h +
- wifi_stop_supplicant() +: wifi.h +
- wifi_unload_driver() +: wifi.h +
- wifi_wait_for_event() +: wifi.h +
+
+
+
+
diff --git a/pdk/docs/globals_type.html b/pdk/docs/globals_type.html
new file mode 100755
index 000000000..ec0afbc91
--- /dev/null
+++ b/pdk/docs/globals_type.html
@@ -0,0 +1,65 @@
+
+
+
+
++
-
+
- do_dhcp_request() +: wifi.h +
- get_dhcp_error_string() +: wifi.h +
- gps_get_hardware_interface() +: gps.h +
- gps_get_interface() +: gps.h +
- gps_get_qemu_interface() +: gps.h +
- wifi_close_supplicant_connection() +: wifi.h +
- wifi_command() +: wifi.h +
- wifi_connect_to_supplicant() +: wifi.h +
- wifi_load_driver() +: wifi.h +
- wifi_start_supplicant() +: wifi.h +
- wifi_stop_supplicant() +: wifi.h +
- wifi_unload_driver() +: wifi.h +
- wifi_wait_for_event() +: wifi.h +
+
+
+
+
diff --git a/pdk/docs/gps.html b/pdk/docs/gps.html
new file mode 100755
index 000000000..eb5473fc1
--- /dev/null
+++ b/pdk/docs/gps.html
@@ -0,0 +1,259 @@
+
+
+
+
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
-
+
Documentation
+-
+
- Introduction + + + +
- Dev Environment Setup
+
-
+
- Build System +
+ - Basic Bring up + + + + +
- Multimedia + + +
- Power Management
+
+
-
+
- Power Management +
+
+ - Networking + + + +
- Telephony
+
-
+
- Radio Interface Layer + +
+ - Testing + + + +
+
+
+
+
+
+
+
+ Introduction
+ +Android defines a user space C abstraction interface for GPS hardware. The interface header is defined in include/hardware/gps.h. In order to integate GPS with Android, you need to build a shared library that implements this interface.
Building a GPS Library
+ +To implement a GPS driver, create a shared library that implements the interface defined in gps.h. You must name your shared library libgps.so so that it will get loaded from /system/lib at runtime. Place GPS sources and Android.mk in partner/acme/chipset_or_board/gps/ (where "acme" is your product name and "chipset_or_board" is your hardware target).
The following stub Android.mk file ensures that libgps compiles and links to the appropriate libraries:
+LOCAL_PATH := $(call my-dir) +include $(CLEAR_VARS) + +LOCAL_MODULE := libgps + +LOCAL_STATIC_LIBRARIES:= \ +# include any static library dependencies + +LOCAL_SHARED_LIBRARIES := \ +# include any shared library dependencies + +LOCAL_SRC_FILES += \ +# include your source files. eg. MyGpsLibrary.cpp + +LOCAL_CFLAGS += \ +# include any needed compile flags + +LOCAL_C_INCLUDES:= \ +# include any needed local header files + +include $(BUILD_SHARED_LIBRARY) ++ + +
Interface
+ + + +Note: This document relies on some Doxygen-generated content that appears in an iFrame below. To return to the Doxygen default content for this page, click here.
+ + + + + + v0.6 - 25 November 2008
+
+
+
diff --git a/pdk/docs/gps_8h-source.html b/pdk/docs/gps_8h-source.html
new file mode 100755
index 000000000..dbf6a16bc
--- /dev/null
+++ b/pdk/docs/gps_8h-source.html
@@ -0,0 +1,298 @@
+
+
+
+
+gps.h
Go to the documentation of this file.00001 /* +00002 * Copyright (C) 2008 The Android Open Source Project +00003 * +00004 * Licensed under the Apache License, Version 2.0 (the "License"); +00005 * you may not use this file except in compliance with the License. +00006 * You may obtain a copy of the License at +00007 * +00008 * http://www.apache.org/licenses/LICENSE-2.0 +00009 * +00010 * Unless required by applicable law or agreed to in writing, software +00011 * distributed under the License is distributed on an "AS IS" BASIS, +00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +00013 * See the License for the specific language governing permissions and +00014 * limitations under the License. +00015 */ +00016 +00017 #ifndef _HARDWARE_GPS_H +00018 #define _HARDWARE_GPS_H +00019 +00020 #include <stdint.h> +00021 +00022 #if __cplusplus +00023 extern "C" { +00024 #endif +00025 +00026 /** Milliseconds since January 1, 1970 */ +00027 typedef int64_t GpsUtcTime; +00028 +00029 /** Maximum number of SVs for gps_sv_status_callback(). */ +00030 #define GPS_MAX_SVS 32 +00031 +00032 /** Requested mode for GPS operation. */ +00033 typedef uint16_t GpsPositionMode; +00034 // IMPORTANT: Note that the following values must match +00035 // constants in GpsLocationProvider.java. +00036 /** Mode for running GPS standalone (no assistance). */ +00037 #define GPS_POSITION_MODE_STANDALONE 0 +00038 /** SUPL MS-Based mode. */ +00039 #define GPS_POSITION_MODE_MS_BASED 1 +00040 /** SUPL MS-Assisted mode. */ +00041 #define GPS_POSITION_MODE_MS_ASSISTED 2 +00042 +00043 /** GPS status event values. */ +00044 typedef uint16_t GpsStatusValue; +00045 // IMPORTANT: Note that the following values must match +00046 // constants in GpsLocationProvider.java. +00047 /** GPS status unknown. */ +00048 #define GPS_STATUS_NONE 0 +00049 /** GPS has begun navigating. */ +00050 #define GPS_STATUS_SESSION_BEGIN 1 +00051 /** GPS has stopped navigating. */ +00052 #define GPS_STATUS_SESSION_END 2 +00053 /** GPS has powered on but is not navigating. */ +00054 #define GPS_STATUS_ENGINE_ON 3 +00055 /** GPS is powered off. */ +00056 #define GPS_STATUS_ENGINE_OFF 4 +00057 +00058 /** Flags to indicate which values are valid in a GpsLocation. */ +00059 typedef uint16_t GpsLocationFlags; +00060 // IMPORTANT: Note that the following values must match +00061 // constants in GpsLocationProvider.java. +00062 /** GpsLocation has valid latitude and longitude. */ +00063 #define GPS_LOCATION_HAS_LAT_LONG 0x0001 +00064 /** GpsLocation has valid altitude. */ +00065 #define GPS_LOCATION_HAS_ALTITUDE 0x0002 +00066 /** GpsLocation has valid speed. */ +00067 #define GPS_LOCATION_HAS_SPEED 0x0004 +00068 /** GpsLocation has valid bearing. */ +00069 #define GPS_LOCATION_HAS_BEARING 0x0008 +00070 /** GpsLocation has valid accuracy. */ +00071 #define GPS_LOCATION_HAS_ACCURACY 0x0010 +00072 +00073 /** Flags used to specify which aiding data to delete +00074 when calling delete_aiding_data(). */ +00075 typedef uint16_t GpsAidingData; +00076 // IMPORTANT: Note that the following values must match +00077 // constants in GpsLocationProvider.java. +00078 #define GPS_DELETE_EPHEMERIS 0x0001 +00079 #define GPS_DELETE_ALMANAC 0x0002 +00080 #define GPS_DELETE_POSITION 0x0004 +00081 #define GPS_DELETE_TIME 0x0008 +00082 #define GPS_DELETE_IONO 0x0010 +00083 #define GPS_DELETE_UTC 0x0020 +00084 #define GPS_DELETE_HEALTH 0x0040 +00085 #define GPS_DELETE_SVDIR 0x0080 +00086 #define GPS_DELETE_SVSTEER 0x0100 +00087 #define GPS_DELETE_SADATA 0x0200 +00088 #define GPS_DELETE_RTI 0x0400 +00089 #define GPS_DELETE_CELLDB_INFO 0x8000 +00090 #define GPS_DELETE_ALL 0xFFFF +00091 +00092 /** +00093 * Name for the GPS XTRA interface. +00094 */ +00095 #define GPS_XTRA_INTERFACE "gps-xtra" +00096 +00097 /** +00098 * Name for the GPS SUPL interface. +00099 */ +00100 #define GPS_SUPL_INTERFACE "gps-supl" +00101 +00102 /** Represents a location. */ +00103 typedef struct { +00104 /** Contains GpsLocationFlags bits. */ +00105 uint16_t flags; +00106 /** Represents latitude in degrees. */ +00107 double latitude; +00108 /** Represents longitude in degrees. */ +00109 double longitude; +00110 /** Represents altitude in meters above the WGS 84 reference +00111 * ellipsoid. */ +00112 double altitude; +00113 /** Represents speed in meters per second. */ +00114 float speed; +00115 /** Represents heading in degrees. */ +00116 float bearing; +00117 /** Represents expected accuracy in meters. */ +00118 float accuracy; +00119 /** Timestamp for the location fix. */ +00120 GpsUtcTime timestamp; +00121 } GpsLocation; +00122 +00123 /** Represents the status. */ +00124 typedef struct { +00125 GpsStatusValue status; +00126 } GpsStatus; +00127 +00128 /** Represents SV information. */ +00129 typedef struct { +00130 /** Pseudo-random number for the SV. */ +00131 int prn; +00132 /** Signal to noise ratio. */ +00133 float snr; +00134 /** Elevation of SV in degrees. */ +00135 float elevation; +00136 /** Azimuth of SV in degrees. */ +00137 float azimuth; +00138 } GpsSvInfo; +00139 +00140 /** Represents SV status. */ +00141 typedef struct { +00142 /** Number of SVs currently visible. */ +00143 int num_svs; +00144 +00145 /** Contains an array of SV information. */ +00146 GpsSvInfo sv_list[GPS_MAX_SVS]; +00147 +00148 /** Represents a bit mask indicating which SVs +00149 * have ephemeris data. +00150 */ +00151 uint32_t ephemeris_mask; +00152 +00153 /** Represents a bit mask indicating which SVs +00154 * have almanac data. +00155 */ +00156 uint32_t almanac_mask; +00157 +00158 /** +00159 * Represents a bit mask indicating which SVs +00160 * were used for computing the most recent position fix. +00161 */ +00162 uint32_t used_in_fix_mask; +00163 } GpsSvStatus; +00164 +00165 /** Callback with location information. */ +00166 typedef void (* gps_location_callback)(GpsLocation* location); +00167 +00168 /** Callback with status information. */ +00169 typedef void (* gps_status_callback)(GpsStatus* status); +00170 +00171 /** Callback with SV status information. */ +00172 typedef void (* gps_sv_status_callback)(GpsSvStatus* sv_info); +00173 +00174 /** GPS callback structure. */ +00175 typedef struct { +00176 gps_location_callback location_cb; +00177 gps_status_callback status_cb; +00178 gps_sv_status_callback sv_status_cb; +00179 } GpsCallbacks; +00180 +00181 +00182 /** Represents the standard GPS interface. */ +00183 typedef struct { +00184 /** +00185 * Opens the interface and provides the callback routines +00186 * to the implemenation of this interface. +00187 */ +00188 int (*init)( GpsCallbacks* callbacks ); +00189 +00190 /** Starts navigating. */ +00191 int (*start)( void ); +00192 +00193 /** Stops navigating. */ +00194 int (*stop)( void ); +00195 +00196 /** Sets requested frequency of fixes in seconds. */ +00197 void (*set_fix_frequency)( int frequency ); +00198 +00199 /** Closes the interface. */ +00200 void (*cleanup)( void ); +00201 +00202 /** Injects the current time. */ +00203 int (*inject_time)(GpsUtcTime time, int64_t timeReference, +00204 int uncertainty); +00205 +00206 /** +00207 * Specifies that the next call to start will not use the +00208 * information defined in the flags. GPS_DELETE_ALL is passed for +00209 * a cold start. +00210 */ +00211 void (*delete_aiding_data)(GpsAidingData flags); +00212 +00213 /** +00214 * fix_frequency represents the time between fixes in seconds. +00215 * Set fix_frequency to zero for a single-shot fix. +00216 */ +00217 int (*set_position_mode)(GpsPositionMode mode, int fix_frequency); +00218 +00219 /** Get a pointer to extension information. */ +00220 const void* (*get_extension)(const char* name); +00221 } GpsInterface; +00222 +00223 /** Callback to request the client to download XTRA data. +00224 The client should download XTRA data and inject it by calling +00225 inject_xtra_data(). */ +00226 typedef void (* gps_xtra_download_request)(); +00227 +00228 /** Callback structure for the XTRA interface. */ +00229 typedef struct { +00230 gps_xtra_download_request download_request_cb; +00231 } GpsXtraCallbacks; +00232 +00233 /** Extended interface for XTRA support. */ +00234 typedef struct { +00235 /** +00236 * Opens the XTRA interface and provides the callback routines +00237 * to the implemenation of this interface. +00238 */ +00239 int (*init)( GpsXtraCallbacks* callbacks ); +00240 /** Injects XTRA data into the GPS. */ +00241 int (*inject_xtra_data)( char* data, int length ); +00242 } GpsXtraInterface; +00243 +00244 /** Extended interface for SUPL support. */ +00245 typedef struct { +00246 /** +00247 * Sets the name of the APN to be used for SUPL. +00248 */ +00249 int (*set_apn)( const char* apn ); +00250 } GpsSuplInterface; +00251 +00252 /** Returns the hardware GPS interface. */ +00253 const GpsInterface* gps_get_hardware_interface(); +00254 +00255 /** +00256 * Returns the qemu emulated GPS interface. +00257 */ +00258 const GpsInterface* gps_get_qemu_interface(); +00259 +00260 /** +00261 * Returns the default GPS interface. +00262 */ +00263 const GpsInterface* gps_get_interface(); +00264 +00265 #if __cplusplus +00266 } // extern "C" +00267 #endif +00268 +00269 #endif // _HARDWARE_GPS_H +
+
+
+
+
+
diff --git a/pdk/docs/group__memory.html b/pdk/docs/group__memory.html
new file mode 100755
index 000000000..44d078280
--- /dev/null
+++ b/pdk/docs/group__memory.html
@@ -0,0 +1,37 @@
+
+
+
+
+gps.h File Reference
++Go to the source code of this file.
Data Structures | |
| struct | GpsLocation |
| Represents a location. More... | |
| struct | GpsStatus |
| Represents the status. More... | |
| struct | GpsSvInfo |
| Represents SV information. More... | |
| struct | GpsSvStatus |
| Represents SV status. More... | |
| struct | GpsCallbacks |
| GPS callback structure. More... | |
| struct | GpsInterface |
| Represents the standard GPS interface. More... | |
| struct | GpsXtraCallbacks |
| Callback structure for the XTRA interface. More... | |
| struct | GpsXtraInterface |
| Extended interface for XTRA support. More... | |
| struct | GpsSuplInterface |
| Extended interface for SUPL support. More... | |
Typedefs | |
| typedef int64_t | GpsUtcTime |
| Milliseconds since January 1, 1970. | |
| typedef uint16_t | GpsPositionMode |
| Requested mode for GPS operation. | |
| typedef uint16_t | GpsStatusValue |
| GPS status event values. | |
| typedef uint16_t | GpsLocationFlags |
| Flags to indicate which values are valid in a GpsLocation. | |
| typedef uint16_t | GpsAidingData |
| Flags used to specify which aiding data to delete when calling delete_aiding_data(). | |
| typedef void(* | gps_location_callback )(GpsLocation *location) |
| Callback with location information. | |
| typedef void(* | gps_status_callback )(GpsStatus *status) |
| Callback with status information. | |
| typedef void(* | gps_sv_status_callback )(GpsSvStatus *sv_info) |
| Callback with SV status information. | |
| typedef void(* | gps_xtra_download_request )() |
| Callback to request the client to download XTRA data. | |
Functions | |
| const GpsInterface * | gps_get_hardware_interface () |
| Returns the hardware GPS interface. | |
| const GpsInterface * | gps_get_qemu_interface () |
| Returns the qemu emulated GPS interface. | |
| const GpsInterface * | gps_get_interface () |
| Returns the default GPS interface. | |
Typedef Documentation
+ +
+
+
+
+
+
+| typedef void(* gps_location_callback)(GpsLocation *location) | +
+
+
+
+
+
+| typedef void(* gps_status_callback)(GpsStatus *status) | +
+
+
+
+
+
+| typedef void(* gps_sv_status_callback)(GpsSvStatus *sv_info) | +
+
+
+
+
+
+| typedef void(* gps_xtra_download_request)() | +
+
+
+
+
+
+| typedef uint16_t GpsAidingData | +
+
+
+
+
+| typedef uint16_t GpsLocationFlags | +
+
+
++Flags to indicate which values are valid in a GpsLocation. +
+ +
+ +
+
+
+
+
+
+| typedef uint16_t GpsPositionMode | +
+
+
+
+
+
+| typedef uint16_t GpsStatusValue | +
+
+
+
+
+
+| typedef int64_t GpsUtcTime | +
+
Function Documentation
+ +
+
+
+
+
+| const GpsInterface* gps_get_hardware_interface | +( | ++ | ) | ++ |
+
+
++Returns the hardware GPS interface. +
+ +
+
+
+
+
+| const GpsInterface* gps_get_interface | +( | ++ | ) | ++ |
+
+
++Returns the default GPS interface. +
+ +
+
+
+
+
+| const GpsInterface* gps_get_qemu_interface | +( | ++ | ) | ++ |
+
+
++Returns the qemu emulated GPS interface. +
+ +
+
+Porividng Heap Memory
+
+This is the text in the "Providing Heap Memory" subgroup
+
+
diff --git a/pdk/docs/group__networking.html b/pdk/docs/group__networking.html
new file mode 100755
index 000000000..6a8e1b846
--- /dev/null
+++ b/pdk/docs/group__networking.html
@@ -0,0 +1,38 @@
+
+
+
+
+Porividng Heap Memory
+
+[Neworking Support]
+
+
+
+
+
+
diff --git a/pdk/docs/groups_8dox.html b/pdk/docs/groups_8dox.html
new file mode 100755
index 000000000..fe63adaf1
--- /dev/null
+++ b/pdk/docs/groups_8dox.html
@@ -0,0 +1,33 @@
+
+
+
+
+Neworking Support
Modules | |
| Porividng Heap Memory | |
Detailed Description
+This is a text for the Networking Support Group
+
+
+
+
+
diff --git a/pdk/docs/index.html b/pdk/docs/index.html
index 834db8ff9..6eac80b5a 100755
--- a/pdk/docs/index.html
+++ b/pdk/docs/index.html
@@ -7,6 +7,18 @@
+
@@ -33,6 +45,7 @@ h1,h2,h3 {
groups.dox File Reference
+
@@ -91,19 +109,18 @@ h1,h2,h3 {
Documentation
- Introduction +
- Dev Environment Setup
- Basic Bring up
+
- Building New Device
- Bring up @@ -111,26 +128,39 @@ h1,h2,h3 {
- Display Drivers
+
- Multimedia
-
-
- Audio Subsystem +
- Audio +
- Camera
- Power Management + + +
- Networking + + +
- Telephony
- Testing +
v0.3 - 9 June 2008
+ v0.6 - 25 November 2008