xref: /btstack/src/hci.c (revision 8adf0dda452dfdcc90e999c1581cd0f7e35e07d6)

/*
 *  hci.c
 *
 *  Created by Matthias Ringwald on 4/29/09.
 *
 */

#include <unistd.h>
#include <stdarg.h>
#include <string.h>
#include <stdio.h>
#include "hci.h"

/**
 *  Link Control Commands
 */
hci_cmd_t hci_inquiry = {
    OPCODE(OGF_LINK_CONTROL, 0x01), "311"
    // LAP, Inquiry length, Num_responses
};
hci_cmd_t hci_inquiry_cancel = {
	OPCODE(OGF_LINK_CONTROL, 0x02), ""
	// no params
};
hci_cmd_t hci_create_connection = {
	OPCODE(OGF_LINK_CONTROL, 0x05), "B21121"
	// BD_ADDR, Packet_Type, Page_Scan_Repetition_Mode, Reserved, Clock_Offset, Allow_Role_Switch
};

hci_cmd_t hci_accept_connection_request = {
	OPCODE(OGF_LINK_CONTROL, 0x09), "B1"
	// BD_ADDR, Role: become master, stay slave
};
hci_cmd_t hci_link_key_request_negative_reply = {
    OPCODE(OGF_LINK_CONTROL, 0x0c), "B"
};
hci_cmd_t hci_pin_code_request_reply = {
    OPCODE(OGF_LINK_CONTROL, 0x0d), "B1P"
    // BD_ADDR, pin length, PIN: c-string
};
hci_cmd_t hci_remote_name_request = {
	OPCODE(OGF_LINK_CONTROL, 0x19), "B112"
	// BD_ADDR, Page_Scan_Repetition_Mode, Reserved, Clock_Offset
};
	hci_cmd_t hci_remote_name_request_cancel = {
	OPCODE(OGF_LINK_CONTROL, 0x1A), "B"
	// BD_ADDR
};

/**
 *  Controller & Baseband Commands
 */
hci_cmd_t hci_set_event_mask = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x01), "44"
    // event_mask lower 4 octets, higher 4 bytes
};
hci_cmd_t hci_reset = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x03), ""
    // no params
};
hci_cmd_t hci_delete_stored_link_key = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x12), "B1"
	// BD_ADDR, Delete_All_Flag
};
hci_cmd_t hci_write_local_name = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x13), "N"
    // Local name (UTF-8, Null Terminated, max 248 octets)
};
hci_cmd_t hci_write_page_timeout = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x18), "2"
    // Page_Timeout * 0.625 ms
};
hci_cmd_t hci_write_scan_enable = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x1A), "1"
    // Scan_enable: no, inq, page, inq+page
};
hci_cmd_t hci_write_authentication_enable = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x20), "1"
    // Authentication_Enable
};
hci_cmd_t hci_write_class_of_device = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x24), "3"
    // Class of Device
};
hci_cmd_t hci_host_buffer_size = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x33), "2122"
    // Host_ACL_Data_Packet_Length:, Host_Synchronous_Data_Packet_Length:, Host_Total_Num_ACL_Data_Packets:, Host_Total_Num_Synchronous_Data_Packets:
};

hci_cmd_t hci_write_inquiry_mode = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x45), "1"
    // Inquiry mode: 0x00 = standard, 0x01 = with RSSI, 0x02 = extended
};

hci_cmd_t hci_write_extended_inquiry_response = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x52), "1E"
    // FEC_Required, Exstended Inquiry Response
};

hci_cmd_t hci_write_simple_pairing_mode = {
    OPCODE(OGF_CONTROLLER_BASEBAND, 0x56), "1"
    // mode: 0 = off, 1 = on
};

hci_cmd_t hci_read_bd_addr = {
	OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x09), ""
	// no params
};

hci_cmd_t hci_get_btstack_state = {
    OPCODE(OGF_BTSTACK, HCI_BTSTACK_GET_STATE), ""
    // no params ->
};


// the stack is here
static hci_stack_t       hci_stack;


void bt_store_16(uint8_t *buffer, uint16_t pos, uint16_t value){
    buffer[pos++] = value;
    buffer[pos++] = value >> 8;
}

void bt_store_32(uint8_t *buffer, uint16_t pos, uint32_t value){
    buffer[pos++] = value;
    buffer[pos++] = value >> 8;
    buffer[pos++] = value >> 16;
    buffer[pos++] = value >> 24;
}

void bt_flip_addr(bd_addr_t dest, bd_addr_t src){
    dest[0] = src[5];
    dest[1] = src[4];
    dest[2] = src[3];
    dest[3] = src[2];
    dest[4] = src[1];
    dest[5] = src[0];
}

void hexdump(void *data, int size){
    int i;
    for (i=0; i<size;i++){
        printf("%02X ", ((uint8_t *)data)[i]);
    }
    printf("\n");
}

/**
 * Linked link list
 */

/**
 * get link for given address
 *
 * @return connection OR NULL, if not found
 */
#if 0
static hci_connection_t *link_for_addr(bd_addr_t addr){
    return NULL;
}
#endif

/**
 * Handler called by HCI transport
 */
static void dummy_handler(uint8_t *packet, uint16_t size){
}

static void acl_handler(uint8_t *packet, int size){
    hci_stack.acl_packet_handler(packet, size);

    // execute main loop
    hci_run();
}

static void event_handler(uint8_t *packet, int size){
    bd_addr_t addr;

    // Get Num_HCI_Command_Packets
    if (packet[0] == HCI_EVENT_COMMAND_COMPLETE ||
        packet[0] == HCI_EVENT_COMMAND_STATUS){
        hci_stack.num_cmd_packets = packet[2];
    }

    // handle BT initialization
    if (hci_stack.state == HCI_STATE_INITIALIZING){
        // handle H4 synchronization loss on restart
        // if (hci_stack.substate == 1 && packet[0] == HCI_EVENT_HARDWARE_ERROR){
        //    hci_stack.substate = 0;
        // }
        // handle normal init sequence
        if (hci_stack.substate % 2){
            // odd: waiting for event
            if (packet[0] == HCI_EVENT_COMMAND_COMPLETE){
                hci_stack.substate++;
            }
        }
    }

    // link key request
    if (packet[0] == HCI_EVENT_LINK_KEY_REQUEST){
        bt_flip_addr(addr, &packet[2]);
        hci_send_cmd(&hci_link_key_request_negative_reply, &addr);
        return;
    }

    // pin code request
    if (packet[0] == HCI_EVENT_PIN_CODE_REQUEST){
        bt_flip_addr(addr, &packet[2]);
        hci_send_cmd(&hci_pin_code_request_reply, &addr, 4, "1234");
    }

    hci_stack.event_packet_handler(packet, size);

	// execute main loop
	hci_run();
}

/** Register L2CAP handlers */
void hci_register_event_packet_handler(void (*handler)(uint8_t *packet, uint16_t size)){
    hci_stack.event_packet_handler = handler;
}
void hci_register_acl_packet_handler  (void (*handler)(uint8_t *packet, uint16_t size)){
    hci_stack.acl_packet_handler = handler;
}

static int null_control_function(void *config){
    return 0;
}
static const char * null_control_name(void *config){
    return "Hardware unknown";
}

static bt_control_t null_control = {
    null_control_function,
    null_control_function,
    null_control_function,
    null_control_name
};

void hci_init(hci_transport_t *transport, void *config, bt_control_t *control){

    // reference to use transport layer implementation
    hci_stack.hci_transport = transport;

    // references to used control implementation
    if (control) {
        hci_stack.control = control;
    } else {
        hci_stack.control = &null_control;
    }

    // reference to used config
    hci_stack.config = config;

    // empty cmd buffer
    hci_stack.hci_cmd_buffer = malloc(3+255);

    // higher level handler
    hci_stack.event_packet_handler = dummy_handler;
    hci_stack.acl_packet_handler = dummy_handler;

    // register packet handlers with transport
    transport->register_event_packet_handler( event_handler);
    transport->register_acl_packet_handler( acl_handler);
}

int hci_power_control(HCI_POWER_MODE power_mode){
    if (power_mode == HCI_POWER_ON) {

        // set up state machine
        hci_stack.num_cmd_packets = 1; // assume that one cmd can be sent
        hci_stack.state = HCI_STATE_INITIALIZING;
        hci_stack.substate = 0;

        // power on
        hci_stack.control->on(hci_stack.config);

        // open low-level device
        hci_stack.hci_transport->open(hci_stack.config);

    } else if (power_mode == HCI_POWER_OFF){

        // close low-level device
        hci_stack.hci_transport->close(hci_stack.config);

        // power off
        hci_stack.control->off(hci_stack.config);
    }

	// trigger next/first action
	hci_run();

    return 0;
}

uint32_t hci_run(){
    uint8_t micro_packet;
    switch (hci_stack.state){
        case HCI_STATE_INITIALIZING:
            if (hci_stack.substate % 2) {
                // odd: waiting for command completion
                return 0;
            }
            if (hci_stack.num_cmd_packets == 0) {
                // cannot send command yet
                return 0;
            }
            switch (hci_stack.substate/2){
                case 0:
                    hci_send_cmd(&hci_reset);
                    break;
				case 1:
					hci_send_cmd(&hci_read_bd_addr);
					break;
                case 2:
                    // ca. 15 sec
                    hci_send_cmd(&hci_write_page_timeout, 0x6000);
                    break;
				case 3:
					hci_send_cmd(&hci_write_scan_enable, 3); // 3 inq scan + page scan
					break;
                case 4:
                    // done.
                    hci_stack.state = HCI_STATE_WORKING;
                    micro_packet = HCI_EVENT_BTSTACK_WORKING;
                    hci_stack.event_packet_handler(&micro_packet, 1);
                    break;
                default:
                    break;
            }
            hci_stack.substate++;
            break;
        default:
            break;
    }

    // don't check for timetous yet
    return 0;
}


int hci_send_acl_packet(uint8_t *packet, int size){
    if (READ_CMD_OGF(packet) != OGF_BTSTACK) {
        return hci_stack.hci_transport->send_acl_packet(packet, size);
    }

    // BTstack internal commands
    uint8_t event[3];
    switch (READ_CMD_OCF(packet)){
        case HCI_BTSTACK_GET_STATE:
            event[0] =  HCI_EVENT_BTSTACK_STATE;
            event[1] = 1;
            event[2] = hci_stack.state;
            hci_stack.event_packet_handler(event, 3);
            break;
        default:
            // TODO log into hci dump as vendor specific"event"
            printf("Error: command %u not implemented\n:", READ_CMD_OCF(packet));
            break;
    }
    return 0;
}

int hci_send_cmd_packet(uint8_t *packet, int size){
    hci_stack.num_cmd_packets--;
    return hci_stack.hci_transport->send_cmd_packet(packet, size);
}

uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, va_list argptr){

    hci_cmd_buffer[0] = cmd->opcode & 0xff;
    hci_cmd_buffer[1] = cmd->opcode >> 8;
    int pos = 3;

    const char *format = cmd->format;
    uint16_t word;
    uint32_t longword;
    uint8_t * ptr;
    while (*format) {
        switch(*format) {
            case '1': //  8 bit value
            case '2': // 16 bit value
            case 'H': // hci_handle
                word = va_arg(argptr, int);  // minimal va_arg is int: 2 bytes on 8+16 bit CPUs
                hci_cmd_buffer[pos++] = word & 0xff;
                if (*format == '2') {
                    hci_cmd_buffer[pos++] = word >> 8;
                } else if (*format == 'H') {
                    // TODO
                }
                break;
            case '3':
            case '4':
                longword = va_arg(argptr, uint32_t);
                // longword = va_arg(argptr, int);
                hci_cmd_buffer[pos++] = longword;
                hci_cmd_buffer[pos++] = longword >> 8;
                hci_cmd_buffer[pos++] = longword >> 16;
                if (*format == '4'){
                    hci_cmd_buffer[pos++] = longword >> 24;
                }
                break;
            case 'B': // bt-addr
                ptr = va_arg(argptr, uint8_t *);
                hci_cmd_buffer[pos++] = ptr[5];
                hci_cmd_buffer[pos++] = ptr[4];
                hci_cmd_buffer[pos++] = ptr[3];
                hci_cmd_buffer[pos++] = ptr[2];
                hci_cmd_buffer[pos++] = ptr[1];
                hci_cmd_buffer[pos++] = ptr[0];
                break;
            case 'P': // c string passed as pascal string with leading 1-byte len
                ptr = va_arg(argptr, uint8_t *);
                memcpy(&hci_cmd_buffer[pos], ptr, 16);
                pos += 16;
                break;
            case 'N': // UTF-8 string, null terminated
                ptr = va_arg(argptr, uint8_t *);
                memcpy(&hci_cmd_buffer[pos], ptr, 248);
                pos += 248;
                break;
            case 'E': // Extended Inquiry Information 240 octets
                ptr = va_arg(argptr, uint8_t *);
                memcpy(&hci_cmd_buffer[pos], ptr, 240);
                pos += 240;
                break;
            default:
                break;
        }
        format++;
    };
    hci_cmd_buffer[2] = pos - 3;
    return pos;
}

uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...){
    va_list argptr;
    va_start(argptr, cmd);
    uint16_t len = hci_create_cmd_internal(hci_cmd_buffer, cmd, argptr);
    va_end(argptr);
    return len;
}

/**
 * pre: numcmds >= 0 - it's allowed to send a command to the controller
 */
int hci_send_cmd(hci_cmd_t *cmd, ...){
    va_list argptr;
    va_start(argptr, cmd);
    uint8_t * hci_cmd_buffer = hci_stack.hci_cmd_buffer;
    uint16_t size = hci_create_cmd_internal(hci_stack.hci_cmd_buffer, cmd, argptr);
    va_end(argptr);
    return hci_send_cmd_packet(hci_cmd_buffer, size);
}