docu makup update

This commit is contained in:
Krzysztof 2016-10-29 20:54:58 +02:00 committed by Ivan Grokhotkov
parent fa002b4909
commit 2d56953ee4

View File

@ -28,37 +28,36 @@ extern "C" {
* *
* This function should be called only once, before any other BT functions are called. * This function should be called only once, before any other BT functions are called.
*/ */
void bt_controller_init(); void bt_controller_init(void);
/** @brief: vhci_host_callback /** @brief vhci_host_callback
* used for vhci call host function to notify what host need to do * used for vhci call host function to notify what host need to do
* *
* notify_host_send_available: notify host can send packet to controller * notify_host_send_available: notify host can send packet to controller
* notify_host_recv: notify host that controller has packet send to host * notify_host_recv: notify host that controller has packet send to host
*/ */
typedef struct vhci_host_callback { typedef struct vhci_host_callback {
void (*notify_host_send_available)(void); void (*notify_host_send_available)(void);
int (*notify_host_recv)(uint8_t *data, uint16_t len); int (*notify_host_recv)(uint8_t *data, uint16_t len);
} vhci_host_callback_t; } vhci_host_callback_t;
/** @brief: API_vhci_host_check_send_available /** @brief API_vhci_host_check_send_available
* used for check actively if the host can send packet to controller or not. * used for check actively if the host can send packet to controller or not.
* return true for ready to send, false means cannot send packet * @return true for ready to send, false means cannot send packet
*/ */
bool API_vhci_host_check_send_available(void); bool API_vhci_host_check_send_available(void);
/** @brief: API_vhci_host_send_packet /** @brief API_vhci_host_send_packet
* host send packet to controller * host send packet to controller
* param data is the packet point, the param len is the packet length * @param data the packet point
* return void *,@param len the packet length
*/ */
void API_vhci_host_send_packet(uint8_t *data, uint16_t len); void API_vhci_host_send_packet(uint8_t *data, uint16_t len);
/** @brief: API_vhci_host_register_callback /** @brief API_vhci_host_register_callback
* register the vhci referece callback, the call back * register the vhci referece callback, the call back
* struct defined by vhci_host_callback structure. * struct defined by vhci_host_callback structure.
* param is the vhci_host_callback type variable * @param callback vhci_host_callback type variable
*/ */
void API_vhci_host_register_callback(const vhci_host_callback_t *callback); void API_vhci_host_register_callback(const vhci_host_callback_t *callback);