Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3e4acb8b authored by Andreas Huber's avatar Andreas Huber
Browse files

Convert all comments into "doxygen-ready" comments. 

Bug: 36453077
Test: make
Change-Id: Ic77394d4d2e1ccedba3a28230d870c5d6108bd40
parent 34e4bc4d

bluetooth/1.0/IBluetoothHci.hal

+1 −1
Original line number Original line Diff line number Diff line
@@ -18,7 +18,7 @@ package android.hardware.bluetooth@1.0; 




import IBluetoothHciCallbacks;

import IBluetoothHciCallbacks;





/*

/**

 * The Host Controller Interface (HCI) is the layer defined by the Bluetooth

 * The Host Controller Interface (HCI) is the layer defined by the Bluetooth

 * specification between the software that runs on the host and the Bluetooth

 * specification between the software that runs on the host and the Bluetooth

 * controller chip. This boundary is the natural choice for a Hardware

 * controller chip. This boundary is the natural choice for a Hardware

bluetooth/1.0/IBluetoothHciCallbacks.hal

+1 −1
Original line number Original line Diff line number Diff line
@@ -16,7 +16,7 @@ 




package android.hardware.bluetooth@1.0;

package android.hardware.bluetooth@1.0;





/* The interface from the Bluetooth Controller to the stack. */

/** The interface from the Bluetooth Controller to the stack. */

interface IBluetoothHciCallbacks {

interface IBluetoothHciCallbacks {

    /**

    /**

     * Invoked when the Bluetooth controller initialization has been

     * Invoked when the Bluetooth controller initialization has been

ir/1.0/IConsumerIr.hal

+2 −2
Original line number Original line Diff line number Diff line
@@ -17,7 +17,7 @@ 
package android.hardware.ir@1.0;

package android.hardware.ir@1.0;





interface IConsumerIr {

interface IConsumerIr {

    /*

    /**

     * transmit() sends an IR pattern at a given carrierFreq.

     * transmit() sends an IR pattern at a given carrierFreq.

     *

     *

     * The pattern is alternating series of carrier on and off periods measured in

     * The pattern is alternating series of carrier on and off periods measured in
@@ -30,7 +30,7 @@ interface IConsumerIr { 
     */

     */

    transmit(int32_t carrierFreq, vec<int32_t> pattern) generates (bool success);

    transmit(int32_t carrierFreq, vec<int32_t> pattern) generates (bool success);





    /*

    /**

     * getCarrierFreqs() enumerates which frequencies the IR transmitter supports.

     * getCarrierFreqs() enumerates which frequencies the IR transmitter supports.

     *

     *

     * returns: On success, true and a vector of all supported frequency

     * returns: On success, true and a vector of all supported frequency

nfc/1.0/INfc.hal

+7 −7
Original line number Original line Diff line number Diff line
@@ -19,7 +19,7 @@ package android.hardware.nfc@1.0; 
import INfcClientCallback;

import INfcClientCallback;





interface INfc {

interface INfc {

    /*

    /**

     * Opens the NFC controller device and performs initialization.

     * Opens the NFC controller device and performs initialization.

     * This may include patch download and other vendor-specific initialization.

     * This may include patch download and other vendor-specific initialization.

     *

     *
@@ -37,7 +37,7 @@ interface INfc { 
    @callflow(next={"write", "coreInitialized", "prediscover", "powerCycle", "controlGranted"})

    @callflow(next={"write", "coreInitialized", "prediscover", "powerCycle", "controlGranted"})

    open(INfcClientCallback clientCallback) generates (NfcStatus status);

    open(INfcClientCallback clientCallback) generates (NfcStatus status);





    /*

    /**

     * Performs an NCI write.

     * Performs an NCI write.

     *

     *

     * This method may queue writes and return immediately. The only

     * This method may queue writes and return immediately. The only
@@ -49,7 +49,7 @@ interface INfc { 
                    "controlGranted"})

                    "controlGranted"})

    write(NfcData data) generates (uint32_t retval);

    write(NfcData data) generates (uint32_t retval);





    /*

    /**

     * coreInitialized() is called after the CORE_INIT_RSP is received from the

     * coreInitialized() is called after the CORE_INIT_RSP is received from the

     * NFCC. At this time, the HAL can do any chip-specific configuration.

     * NFCC. At this time, the HAL can do any chip-specific configuration.

     *

     *
@@ -62,7 +62,7 @@ interface INfc { 
    @callflow(next={"write", "prediscover", "close"})

    @callflow(next={"write", "prediscover", "close"})

    coreInitialized(NfcData data) generates (NfcStatus status);

    coreInitialized(NfcData data) generates (NfcStatus status);





    /*

    /**

     * prediscover is called every time before starting RF discovery.

     * prediscover is called every time before starting RF discovery.

     * It is a good place to do vendor-specific configuration that must be

     * It is a good place to do vendor-specific configuration that must be

     * performed every time RF discovery is about to be started.

     * performed every time RF discovery is about to be started.
@@ -76,7 +76,7 @@ interface INfc { 
    @callflow(next={"write", "close", "coreInitialized", "powerCycle", "controlGranted"})

    @callflow(next={"write", "close", "coreInitialized", "powerCycle", "controlGranted"})

    prediscover() generates (NfcStatus status);

    prediscover() generates (NfcStatus status);





    /*

    /**

     * Close the NFC controller. Should free all resources.

     * Close the NFC controller. Should free all resources.

     *

     *

     * @return NfcStatus::OK on success and NfcStatus::FAILED on error.

     * @return NfcStatus::OK on success and NfcStatus::FAILED on error.
@@ -84,7 +84,7 @@ interface INfc { 
    @exit

    @exit

    close() generates (NfcStatus status);

    close() generates (NfcStatus status);





    /*

    /**

     * Grant HAL the exclusive control to send NCI commands.

     * Grant HAL the exclusive control to send NCI commands.

     * Called in response to NfcEvent.REQUEST_CONTROL.

     * Called in response to NfcEvent.REQUEST_CONTROL.

     * Must only be called when there are no NCI commands pending.

     * Must only be called when there are no NCI commands pending.
@@ -95,7 +95,7 @@ interface INfc { 
    @callflow(next={"write", "close", "prediscover", "coreInitialized", "powerCycle"})

    @callflow(next={"write", "close", "prediscover", "coreInitialized", "powerCycle"})

    controlGranted() generates (NfcStatus status);

    controlGranted() generates (NfcStatus status);





     /*

     /**

     * Restart controller by power cyle;

     * Restart controller by power cyle;

     * NfcEvent.OPEN_CPLT will notify when operation is complete.

     * NfcEvent.OPEN_CPLT will notify when operation is complete.

     *

     *

nfc/1.0/INfcClientCallback.hal

+2 −2
Original line number Original line Diff line number Diff line
@@ -17,13 +17,13 @@ 
package android.hardware.nfc@1.0;

package android.hardware.nfc@1.0;





interface INfcClientCallback {

interface INfcClientCallback {

    /*

    /**

     * The callback passed in from the NFC stack that the HAL

     * The callback passed in from the NFC stack that the HAL

     * can use to pass events back to the stack.

     * can use to pass events back to the stack.

     */

     */

    sendEvent(NfcEvent event, NfcStatus status);

    sendEvent(NfcEvent event, NfcStatus status);





    /*

    /**

     * The callback passed in from the NFC stack that the HAL

     * The callback passed in from the NFC stack that the HAL

     * can use to pass incomming data to the stack.

     * can use to pass incomming data to the stack.

     */

     */