Home

BISM-II Multipoint Firmware

1. ne a an a SS The following are COMMAND octet 2 values in command response packets a in cn Ls a define CMD_NO_OPERATION 0x01 define CMD_READ_BDADDR 0x02 define CMD_READ_SREG 0x03 define CMD_WRITE_SREG 0x04 JEE EE EE EE EE EE EE EE EE EE EE EE EE EE EE EE EE EE EE EE EE EE The following are EVENT octet 2 values in event packets as a a i nn a ac define EVT_STATUS 0x81 define EVT_INVALID_PKTSIZE 0x82 define EVT_UNKNOWN_COMMAND 0x83 define EVT_INQUIRY_RESUL 0x84 define EVT_MODEM_STATUS 0x85 SEND REQUEST TO multipoint Ezurio com FOR LATEST VERSION OF THIS HEADER FILE 5 3 STATUS values The following is a listing of a snapshot of the file MPSTATUS H at the time of writing this document Ezurio does NOT guarantee that this listing will be kept up to date For development purposes please send a request to serial Ezurio com for the latest version of the C header file define MPSTATUS_OK 0x00 define MPSTATUS_ILLEGAL COMMAND 0x01 define MPSTATUS_NO_CONNECTION 0x02 define MPSTATUS_HARDWARE_FAIL 0x03 define MPSTATUS_PAGE_TIMEOUT 0x04 GI SEND REQUEST TO multipoint Ezurio com FOR LATEST VERSION OF THIS HEADER FIL Americas 1 800 4
2. EVT_REM_FNAME index 20 len 5 CMD_REM_FNAME namelen 47 start 0 sent 25 CMD_REM_FNAME bdaddr timeout start 25 maxbytes 22 Got Friendly Name 47 bytes EVT_REM_FNAME index 25 len 10 2 2 EVT_REM_FNAME index 35 len 10 2 EVT_REM_FNAME index 45 len 2 CMD_REM_FNAME namelen 47 start 25 sent 22 Americas 1 800 492 2320 Option 3 37 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 6 3 Get Local Friendly Name This command is used read the local friendly name which is stored in non volatile memory Unlike the remote friendly name where there is no control over the max length the local friendly name is limited to 31 characters This length still may too big to send to the host in one packet Therefore the name is sent in a similar fashion to get friendly name However in this case the event EVT_LCL_FNAME is used to get the name to the host 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_GET_LCL_FNAME 3 FLOW_IN Runtime value 4 START n Offset into the friendly name string 5 MAXBYTES m Max characters to read 0 LENGTH Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_GET_LCL_FNAME 3 HOW OUT Runtime value 4 STATUS As appropriate 5 NAMELEN 0 31 Actual size of the friendly name 6 START n Echoed from the command 7 SENTLEN e Total number of
3. 4 4 5 ADC value This event is used to send the ADC input reading of the ADC channel requested in the most recent CMD GET IO command 0 LENGTH 7 1 CHANNEL 0 2 EVENT EVT_ADC 3 HOW OUT Runtime value 4 adcld 1 2 ADC channel Id 5 adcValMsb Runtime value 6 adcValMsb Runtime value 4 5 Debug Events 4 5 1 Debug Packet This event is used to convey debugging information to the host and will be available in engineering beta builds only 0 LENGTH 16 1 CHANNEL 0 2 EVENT EVT_DEBUG_PACKET 3 HOW OUT Runtime value Bit O First Packet Bit 1 Last Packet j ER AK Bit 2 5 Reserved Bit 6 7 Message Type 5 15 DATA Contains Ascii data String conveying message Americas 1 800 492 2320 Option 3 49 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 5 MISCELLANEOUS This chapter contains miscellaneous information 5 1 S Registers This section details all the configuration S registers Mim and Max values are given in decimal unless the value is prefixed by Ox in that case the value is in hexadecimal 1 01 0 0 Host Interface 2 02 16 255 Maximum data packet size from module to host Server Profile record Mask Bit O SPP Bit 1 HEADSET 3 03 1 Ox1F Bit 2 DUN Bit 3 AUDIO GATEWAY Bit 4 HANDSFREE 4 04 0 1 Default Connectable Mode on power up reset 5 05 0 1 Def
4. Runtime value 4 STATUS As appropriate 5 10 BDADDR _Nap 0 1 Uap 2 Lap 3 4 5 11 COUNT 1 3 Total SCO channels open 12 13 HANDLE 2 byte SCO Handle 14 INCOMING 0 1 1 if SCO was established by peer Americas 1 800 492 2320 Option 3 45 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 4 3 7 SCO Disconnect This event is used to inform the host that a SCO connection has been cleared 0 LENGTH 15 1 CHANNEL 0 2 EVENT EVT_SCO_DISCONNECT 3 HOW OUT Runtime value 12 13 HANDLE 2 byte SCO Handle 14 REASON XX 4 3 8 SCO Incoming Setup This event is used to inform the host that a peer is attempting to establish a SCO connection and the host needs to accept or reject using the CMD_SCO_INCOMING_SETUP command packet 0 LENGTH 13 1 CHANNEL 0 2 EVENT EVT_ SCO_CONNECT 3 HOW OUT Runtime value 4 9 BDADDR _Nap 0 1 Uap 2 Lap 3 4 5 10 COUNT 1 3 11 12 HANDLE 2 byte SCO Handle Total SCO channels open When the host sends the CM_SCO_INCOMING_SETUP command packet in response to this event is MUST echo the BDADDR and HANDLE fields from this event packet 4 3 9 Remote Features This event is used to inform the host that the peer just about to connect has the feature list as provided in the message 0 LENGTH 18 1 CHANNEL 0 2 EVENT EVT_REMOTE_FEATURES 3 H
5. 0 LENGTH Fixed 1 CHANNEL U Fixed 2 COMMAND CMD_ DROP CONNECTION 3 HOW OUT Runtime value 4 STATUS As appropriate 5 HANDLE 0 255 Echoed from the command If the STATUS field in the response is MPSTATUS_OK the request to drop the channel was successfully submitted to the lower stack layers When the channel is dropped an EVT_DISCONNECT event is sent to the host Note Prior to v0 1 14 the meaning of this message was If the STATUS field in the response is MPSTATUS_OK then the channel was successfully destroyed Any other value is a failure The meaning of this message was changed post 0 1 14 to make it easier for the host as it now needs to cater for only EVT_DISCONNECT to mean that a connection has been dropped 3 3 5 Set Modem Lines Bluetooth Serial Port Profile is capable of exchanging modem signals DTR DSR RTS CTS DCD and RI over air From a host s perspective it can have DTR RTS DCD and RI as output lines Note DCD and RI are outputs for modems and host in this context can mean either a PC or a peripheral like a modem Additionally UARTs are capable of sending BREAK signals BREAK output signals are defined as a non idle state TX pin for a period much greater than the character width at the current baud rate setting This command is used to send DTR RTS DCD and RI states to the peer device and also to specify a BREAK Americas 1 800 492 2320 Option 3 20 Laird Technologies Europe 44 1628
6. 3 slot Enhanced Data Rate ACL packets 5 slot Enhanced Data Rate ACL packets Reserved 5 2 ER 5 4 5 5 5 6 5 7 6 0 Reserved AFH capable master AFH classification master Enhanced Data Rate eSCO 2 Mbps mode Enhanced Data Rate eSCO 3 Mbps mode Reserved Reserved Reserved 6 2 6 3 6 4 6 5 6 6 Reserved Reserved Reserved Reserved Reserved Reserved 7 0 Reserved Reserved Reserved 13 7 4 157 7 6 7 7 Reserved Reserved Reserved Reserved Extended features 4 4 Miscellaneous Events 4 4 1 Link Key This event is used to inform the host that a new link key has been created for the device indicated and the result of writing to the ROLLING database U LENGTH 11 1 CHANNEL 0 2 EVENT EVT_ LINK_KEY 3 HOW OUT Runtime value A 9 BDADDR 6 Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address of paired device 10 DBRESULT 0 Success Any other value is a failure and the reason is a STATUS value as per MPSTATUS H Americas 1 800 492 2320 Option 3 Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth Laird Technologies BISM II Multipoint Firmware User s Guide 4 4 2 Pin Code Request This event is used to inform the host that a remote device has requested a pairing and a pin code is required to complete the procedure 0 LENGTH 10 1 CHANNEL 0 2 EVENT EVT_ PINCODE_REQUEST 3 HOW OUT Runtime value 4 9 BDADDR
7. and has meaning specific to the response for COMMAND The only difference between a response and an event packet is that in the latter octet 2 is defined as COMMAND in the former and EVENT in the latter Also in the latter the STATUS field is missing The value of COMMAND shall be in the range 0 to Ox7F and EVENT shall take values in the range 0x80 to OxFF This allows bit 7 of that octet to be used to decode whether the packet is a response packet or an event packet The value of STATUS is in the range 0 to 255 A value of O means SUCCESS and any other value is a failure where the value gives more details of the failure type The values of STATUS are defined in a C header file which can be obtained on request from Ezurio 2 2 3 Data Packets The format for data packets is as per the table below The only method by which the host can stop the module from sending this message is by sending a O value in the FLOW_IN field of command message 0 LENGTH Total length of this packet including this octet Bits O to 4 contain the value as per the channel id value returned in a successful 1 CHANNEL connection message It will be a value in the range 1 to 31 Bits 5 6 7 are reserved for future use and should always be set to 0 2 N DATA Data received over the air for the channel Data packets are symmetrical in both directions Americas 1 800 492 2320 Option 3 8 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0
8. bytes sent in preceding events The name string is sent to the host in EVT_LCL_FNAME packets See description of Get Remote Friendly name Note SENTLEN could be less than MAXBYTES It can happen if there is no space in the module s TX buffer to send events 3 6 4 Set Local Friendly Name This command is used to set the local friendly name in non volatile memory so that it is used after a power up reset cycle Since the module can cope with large packets the name sent to the module in a single command packet as a null terminated string Americas 1 800 492 2320 Option 3 38 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 0 LENGTH 36 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SET_LCL_FNAME 3 FLOW_IN Runtime value 4 FLAGS 1 Bit 0 Set to store in nonvol memory MUST ALWAYS BE SET TO 1 Bits 1 7 Future use 5 NAMELEN 1 30 6 36 NAME 31 Null terminated string Not more than 30 characters 0 LENGTH Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SET_LCL_FNAME 3 HOW OUT Runtime value 4 STATUS As appropriate Note Future releases will allow setting the friendly name immediately in the baseband and or storage in non volatile memory The mechanism for this will be via bit flags in field FLAGS 3 6 5 Get Digital Analog I O This command is used read the states of up to 16 dig
9. command results in no action other than to convey new FLOW IN status to the module and get a response packet with the latest status for the FLOW_OUT bits It is expected that a host will use this packet to poll for a change in the flow bits 0 LENGTH 4 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_NO_OPERATION 3 FLOW_IN Runtime value 0 LENGTH 5 1 CHANNEL 0 2 COMMAND CMD_NO_OPERATION 3 HOW OUT Runtime value 4 STATUS OK Or INVALID_LICENSE Americas 1 800 492 2320 Option 3 10 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 1 2 Get Connectable Discoverable Security Modes This command is used to get the current mo connectable discoverable and security modes 0 LENGTH 4 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_GET_MODES 3 FLOW_IN Runtime value 0 LENGTH 8 1 CHANNEL 0 2 COMMAND CMD_GET_MODES 3 HOW OUT Runtime value 4 STATUS OK or INVALID_LICENSE 5 DISCMODE 0 1 1 for discoverable mode Bit 0 1 for connectable mode 6 CONNMODE 0 7 Bit 1 1 for Auto Accept Channe1 Bit 2 1 for Auto Accept Mux O No Auth No Encryption 7 SECMODE 0 2 1 Auth No Encryption 2 Auth Encryption 3 1 3 Read Local Bluetooth Address This command is used to read the Bluetooth address of the module 0 LENGTH 4 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_
10. is echoed in offset 4 0 LENGTH 1 CHANNEL 2 EVENT EVT_UNKNOWN_COMMAND 3 HOW OUT Runtime value 4 command xx COMMAND value echoed from command Americas 1 800 492 2320 Option 3 41 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 4 2 2 Status This event is used to asynchronously send current status to the host This event is sent to the host after power up to inform the host that the module is ready and operational The information contained in this message can also be obtained by sending the CMD_GET_MODES command 0 LENGTH 8 1 CHANNEL 0 2 EVENT EVT_ STATUS 3 HOW OUT Runtime value 4 STATUS OK or INVALID_LICENSE 5 DISCMODE 0 1 1 for discoverable mode Bit 0 1 for connectable mode 6 CONNMODE 0 7 Bit 1 1 for Auto Accept Channe1 Bit 2 1 for Auto Accept Mux 0 No Auth No Encryption 7 SECMODE 0 2 1 Auth No Encryption 2 Auth Encryption 4 2 3 Invalid Packet Size This event is used to inform the host that a command packet has been received whose length does not 0 LENGTH 7 1 CHANNEL 0 2 EVENT EVT_INVALID_PKTSIZE 3 HOW OUT Runtime value 4 COMMAND 1 127 Echoed from the command 5 ACTSIZE A Actual size of the packet 6 DESSIZE D Desired size of the packet Americas 1 800 492 2320 Option 3 42 Laird Technologies Europe 44 1628 858 940 H
11. the host The host protocol provides for a command to transfer a record between these two databases In addition there is a command for the host to determine if a device is trusted Note Pairing initiation or accept procedures can only be entered if there are no existing connections 3 5 1 Pair Initiate This command is used to initiate a pairing with a peer device which is assumed to be ready and waiting for a pairing 0 LENGTH 28 Fixed 1 CHANNEL U Fixed 2 COMMAND CMD_ PAIR_INITIATE 3 FLOW_IN 2 Runtime value 4 TIMEOUT 5 120 Pairing timeout in seconds 5 10 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr of device to be paired 11 27 d 17 byte string array Null Terminated Pin code String Max pin code length is 16 U LENGTH 5 Fixed 1 CHANNEL U Fixed 2 COMMAND CMD_ PAIR_INITIATE 3 HOW OUT Runtime value 4 STATUS As appropriate If pairing is successful the event message EVT_LINK_KEY will be sent to the host before the response to close the procedure as shown in the message sequence chart below Americas 1 800 492 2320 Option 3 30 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide Note Pair Initiate will fail if there are any existing open connections The status byte in the response will have an appropriate value HOST MODULE CMD_PAIR_INITIATE bdaddr pincod
12. 1 12 UUID Ox1101 Ox11xx FE eg 13 INSTANCE 0 255 al instance of the profile 1 is the 0 LENGTH 7 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ MAKE CONNECTION 3 HOW OUT Runtime value 4 STATUS As appropriate 5 HANDLE 0 255 Echoed from the command Channel Id to be used for subsequent data 6 CHANNEL fei packets and also when dropping the connection If the STATUS field in the response is MPSTATUS_OK then a connection was successfully established Any other value is a failure The timeout specified in S register 16 is used to abort the connection attempt if it takes too long Likewise once the connection is established the value of S register 12 is used to specify the link supervision timeout Finally the content of S register 11 is used to specify the max frame size to be used by the lower layers 0 means use default value Americas 1 800 492 2320 Option 3 19 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 3 4 Drop Connection This command is used to destroy an existing channel 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ DROP CONNECTION 3 FLOW_IN 2 Runtime value 0 255 Can be any value the This value is echoed by the module in the 4 HANDLE host wants to set response As was specified in either 5 CHANNEL 1 7 RSP_MAKE_CONNECTION or EVT_INCOMMING_CONNECTION
13. 10 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide The value of COMMAND shall be in the range 0 to 127 Unknown command values result in an EVT_UNKNOWN_COMMAND event with the command value reflected in the data field If the octet value is specified in the range 128 to 255 0x80 to OxFF then reflecting that value in the data field of an EVT_LUNKNOWN_COMMAND instead of the COMMAND field of a response packet guarantees that the packet will NOT be mistakenly processed as an event 2 1 2 Data Packets The format for data packets is as per the table below and can arrive at any time The only method by which the host can be stopped from sending this message is by sending a O value in the FLOW_OUT field of a response or status message The module will be prepared to receive at least one data packet after deasserting the appropriate flow control bit If CHANNEL is OxFF then the data packet is broadcast to all open channels Future feature 0 LENGTH Total length of this packet including this octet Bits O to 4 contain the value as per the channel id value returned in a successful 1 CHANNEL connection message It will be a value in the range 1 to 31 Bits 5 6 7 are reserved for future use and should always be set to 0 2 N DATA This data array is unconditionally sent over the air 2 2 Module to Host Packets These are packets used to convey responses or events from the module and raw data received over an op
14. 58 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 6 Miscellaneous Commands 3 6 1 Set Get Security Mode This command is used to set or get the current security mode of the module The module can be in one of three modes No authentication 0 Authentication Only 1 Authentication and Encryption 2 These modes are applied to all connection attempts whether inbound or outbound Specifying a value of OxFF means leave the mode as it is but inform the host with regards to current mode 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SECURITY_MODE 3 FLOW_IN 2 Runtime value 0 No Auth No Encryption 4 SECMODE 0 2 OXFF Poeun EEN 2 Auth Encryption OxFF Get current mode U LENGTH 6 Fixed 1 CHANNEL U Fixed 2 COMMAND CMD_SECURITY_MODE 3 HOW OUT Runtime value 4 STATUS As appropriate 5 SECMODE 0 2 Current mode 3 6 2 Get Remote Friendly Name This command is used to get the friendly name of the specified peer device According to the Bluetooth specification a friendly name can be up to 248 bytes long Sending this name in one go to the host could violate the max packet length capability of the host due to memory restrictions in the host OR transmit buffers in the module may not be able to cope Therefore the mechanism for getting the name to the host is via event packets EVT_REM_FNAME The host decides how many bytes of
15. 6 Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address of pairing device The host shall send a CMD_PINCODE in response to this event This event is only received if accept pairing while in connectable mode is enabled via S Register 15 4 4 3 Local Friendly Name This event is used to send a fragment of the local friendly name to the host The maximum length of the fragment is 10 so at least 3 of these events are required to convey a local friendly name if it has the maximum length of 30 0 LENGTH 16 1 CHANNEL 0 2 EVENT EVT_LCL_FNAME 3 HOW OUT Runtime value 4 INDEX 0 29 Start index into the string 5 LEN 1 10 Number of valid characters in the NAME field that follows 6 15 NAME 10 Xx XX xx XX The name fragment 4 4 4 Remote Friendly Name This event is used to send a fragment of the remote friendly name to the host The maximum length of the fragment is 10 so at least 25 of these events are required to convey a remote friendly name if it has the maximum length of 248 0 LENGTH 16 1 CHANNEL 0 2 EVENT EVT_REM_FNAME 3 HOW OUT Runtime value 4 INDEX 0 247 Start index into the string 5 LEN 1 10 Number of valid characters in the NAME field that follows 6 15 NAME 10 MN xx xx AN The name fragment Americas 1 800 492 2320 Option 3 48 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide
16. 610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 2 3 Host Packet Receive Flowchart As maximum data throughput is the design goal the format and detail of packets have been optimised Implement the following flowchart in the host for rapid servicing and flow control of the packets On Packet Receive No Data Yes Command Process DATA Yes Response Pkt 2 amp 0x80 Process EVENT Process RESPONSE Americas 1 800 492 2320 Option 3 9 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 HOST COMMAND RESPONSES This section describes all host commands in detail and is specified via the COMMAND field of all command packets The description for each command below is in the form of a command packet table and a corresponding response packet table Each command has a unique COMMAND value in the range 1 to 127 0x01 to 0x7F O is reserved The actual value of COMMAND in the Value column is described as Descriptive_Name where Descriptive_Name can be found in a C header file which can be obtained on request from Ezurio The value of STATUS is similarly defined in a header file which can be obtained from Ezurio by request 3 1 Information Commands This group of commands are used to obtain information about the module 3 1 1 No Operation This
17. 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 0 LENGTH 7 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ CONTROLMODEMLINES 3 FLOW_IN Runtime value 4 CHANNEL Ted Channel ID of an open channel Bit 0 DTR state Bit 1 RTS state 5 MODEM Bit Mask Bit 2 DCD state Bit 3 RI state 6 BREAK 0 For future implementation 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ CONTROLMODEMLINES 3 HOW OUT Runtime value 4 STATUS As appropriate 5 CHANNEL 1 7 Echoed from command The STATUS value will be MPSTATUS_OK if the message was successful Modem signals sent by the peer device are presented to the host in the message EVT_MODEM_STATUS defined in subsequent chapters Note BREAK signal capability is currently not provided by the lower stack and so it is mentioned in the context of this command message for future implementation 3 3 6 SCO Connect This command is used to establish an SCO channel alongside a pre existing connection SCO channels are used to transfer audio between peers and is bi directional 0 LENGTH 11 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SCO_CONNECT 3 FLOW_IN H Runtime value 4 9 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address Bit 0 HV1 EV3 Bit 1 HV2 EV4 10 PKTTYPE Bit Mask Bit 2 HV3 EV5 Bit 3 Enhanced Sco Americas 1 800 492 2320 Option 3 21 Laird Technologie
18. 92 2320 Option 3 52 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth
19. D_SET_IO 3 HOW OUT Runtime value 4 STATUS As appropriate Americas 1 800 492 2320 Option 3 40 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 4 MODULE EVENTS This section describes all module originated asynchronous events in detail and is specified via the EVENT field of all event packets The description for each event below is in the form of an event packet tables Each event has a unique EVENT value in the range 129 to 255 0x81 to OxFF 0x80 is reserved The actual value of EVENT in the Value column is described as Descriptive_Name where Descriptive_Name can be found in a C header file which can be obtained on request from Ezurio 4 1 Inquiry Events This group of events are inquiry related 4 1 1 Inquiry Result This event is used to send the inquiry response from a peer as a result of an inquiry request 0 LENGTH 13 1 CHANNEL 0 2 EVENT EVT_ INQUIRY_RESULT 3 FLOW_OUT H Runtime value 4 9 BDADDR 6 Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address of responding device 10 12 DEVCLASS 3 0x000000 OxFFFFFF Device class of responding device 4 2 Information Events This group of events are used to convey information about the module for example to status 4 2 1 Unknown Command This event is used to inform the host that a command was received with an unknown COMMAND value The COMMAND value
20. Fixed 2 COMMAND CMD_PINCODE 3 FLOW_IN 2 Runtime value 49 BDADDRI Naplo 1 Uap 2 Lap 3 4 5 GE address of device requesting the Null Terminated Pin code String Max pin 10 26 PIN 17 byte string array code length is 16 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_PINCODE 3 HOW OUT Runtime value 4 STATUS As appropriate If pairing is successful the event message EVT_LINK_KEY will be sent to the host after the response Americas 1 800 492 2320 Option 3 32 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 5 4 Trusted Database Record Count This command is used to obtain the number of trusted devices in the database specified 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ TRUSTED_DB_COUNT 3 FLOW_IN Runtime value 4 DBTYPE ER 0 ROLLING DATABASE 1 PERSISTANT DATABASE 0 LENGTH 8 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ TRUSTED_DB_COUNT 3 HOW OUT Runtime value 4 STATUS As appropriate 5 DBTYPE 0 1 Echoed from command 6 COUNT ON Number of trusted devices in this database Maximum number of devices that can i MASSE UN be stored in this database Note ROLLING database is used to store all new pairings It is up to the host to transfer a record from ROLLING to the PERSISTANT database 3 5 5 Trusted Database Read Record Thi
21. IN Runtime value 4 MAXRESP 1 255 e eg of responses before aborting the 5 TIMEOUT 1 120 Time in seconds before aborting the inquiry procedure 6 FLAGS 0 Future use Americas 1 800 492 2320 Option 3 28 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 0 LENGTH 7 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_INQUIRY_REQ 3 HOW OUT Runtime value 4 STATUS As appropriate 5 TOTAL 7 The total number of inquiry responses that were received from peers The total number of inquiry result events that were 6 DUMP 7 NOT sent because the transmit buffer of the module was full This will be as a result of the host deasserting its RTS line As a result of this command as and when peer devices respond with inquiry responses for each inquiry response an event EVT_INQUIRY_RESULT is sent to the host When the number of inquiry responses specified in the command are received OR the specified time has elapsed the response will be sent to indicate to the host that the inquiry procedure is complete If the DUMP field in the response is non zero it is indicating that the host is not reading it s receive buffer fast enough and is resulting in RTS being deasserted towards the module 3 4 2 Set Discoverable Mode This command is used to enable disable discoverable mode o LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ DI
22. Laird gt BISM II Multipoint Firmware User s Guide Version 1 2 global local Americas 1 800 492 2320 Option 2 Europe 44 1628 858 940 Hong Kong 852 2923 0610 BISM II Multipoint Firmware User s Guide REVISION HISTORY 1 0 23 May 2012 Initial version 1 1 14 August 2013 Updated PinCode parameters in section 3 5 3 PinCode 1 2 31 October 2013 Updated Max Slave connections Americas 1 800 492 2320 Option 3 2 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide Revision Historie 1 1 Jude la dl EEN 5 1 1 Flow control amp Data lntegortv ninrin nia Eaa aa S 5 1 2 Maximum Packet Size Consideraton etetett tr tE EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE 5 d Packet General Format viicsccccscccscecsccasscessssssdecssascscnasanesecasasacenssenacecesentsendseedceesevsdunasesiesvasuvacusasunanasasavan 6 2 1 Host to Module Packets 0 cccccccesssesssesceeeeeeeeeeeeeeeeeeuseaeaeeeececeeeeeceueeeceneeeeeeeeeeeueneneneneueneneneneneneeess 6 21 1 Command PACKCUS renen a uuphed satwesnvneadtnda duane via a ane Bend A 6 E EE EE PACk EE 7 22 Mod le to Host Packets age innin stands SEENEN EE EE a ETE a eaaa 7 2 2 1 Response backets rtrt rn tEntEESSEESEEENEEESSEESSEESEEEAEEEEEEEEEEEES EEES EE EEEn EEE 7 2 22 Event Packets corine a a a O 8 E Data Pi E EE 8 2 3 Host Packet Receive Flowchart cccccccccccsssseseceeeeese
23. OW OUT Runtime value 4 9 BDADDR _Nap 0 1 Uap 2 Lap 3 4 5 10 17 FEATURE 8 bytes The feature list as described belo The feature list as as described below Americas 1 800 492 2320 Option 3 46 Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth Laird Technologies BISM II Multipoint Firmware User s Guide 0 0 3 Slot packets 0 1 5 Slot packets 0 2 Encryption 0 3 Slot Offset 0 4 Timing accuracy 0 5 Role switch 0 6 Hold mode 0 7 Sniff Mode O Park State 1 1 Power control requests 1 2 Channel quality driven data rate CQDDR 1 3 SCO link 1 4 HV2 packet 1 5 HV3 packet 1 6 u law log synchronous data 1 7 A law log synchronous data 0 CVSD synchronous data 2 1 Paging parameter negotiation 2 2 Power control 2 3 Transparent synchronous data 2 4 Flow control lag least significant bit 2 5 Flow control lag middle bit 2 6 Flow control lag most significant bit 2 7 Broadcast encryption 3 0 Reserved 3 1 Enhanced Data Rate ACL 2 Mbps mode 3 2 Enhanced Data Rate ACL 3 Mbps mode 3 3 Enhanced Inquiry Scan 3 4 Interlaced Inquiry Scan 3 5 Interlaced Page Scan 3 6 RSSI with inquiry results 3 7 Extended SCO lin EV3 packets 4 0 4 1 4 6 5 1 6 1 6 7 7 1 7 2 EV4 packets gt EV5 packets 4 2 4 3 4 4 4 5 Reserved AFH capable slave AFH classification slave Reserved Reserved 4 7 5 0
24. READ_BLUETOOTH_ADDRESS 3 FLOW_IN Runtime value 0 LENGTH 11 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_READ_BLUETOOTH_ADDRESS 3 HOW OUT Runtime value 4 STATUS Ok 5 10 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address Americas 1 800 492 2320 Option 3 11 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 1 4 Information This command is used to extract information from the module for example version number 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_INFORMATION 3 FLOW_IN H Runtime value 4 INFOTYPE 0 255 0 LENGTH 14 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_INFORMATION 3 HOW OUT Runtime value 4 STATUS OK 5 INFOTYPE 0 255 Echoed from command 6 13 DATA 8 As per the table below The type of information requested is specified by the INFOTYPE parameter as per the table below Firmware skew Custom firmware is S MERGEN K differentiated with this field VERSION_MAJOR 0 255 Major version number 2 VERSION_MINOR 0 255 Minor version number 3 VERSION_ENG 0 255 ee MAX_INFO_TYPE N Max value of INFOTYPE field 5 6 CSR STACK BUILD No 0 65535 Offset 5 MSB Reserved Any value Ezurio private Use 0 7 Manufacturer Name E g CSR Chip manufacturer null terminated string Americas 1 800 492 2320 Option 3 12 Laird Te
25. Runtime value 4 STATUS As appropriate 5 CURMODE 0 1 0 Not connectable 1 Connectable In future releases of the firmware the ability to accept reject incoming RFCOMM mux setup will be provided Until then mux setups will be automatically accepted The module will use the parameters stored in S Registers 9 and 10 to set the inquiry scan interval and window Americas 1 800 492 2320 Option 3 IF Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 3 2 Service Incoming Connection When the module is in connectable mode incoming connection requests are passed up to the host via an EVT_CONNECTION_SETUP message The host accepts or rejects the remote connection request using this message 0 LENGTH 12 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ CONNECTION_SETUP 3 FLOW_IN Runtime value 4 9 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr 10 HANDLE E any value the host E by the module in 11 ACCEPT 0 1 0 reject 1 accept 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ CONNECTION_SETUP 3 HOW OUT Runtime value 4 STATUS As appropriate 5 HANDLE 0 255 Echoed from the command Receipt of the response is not an indication that the connection has been established If the connection is to be accepted the module will send EVT_INCOMING_CONNECTION when the connection has been ful
26. SCOVERABLE_MODE 3 FLOW_IN Runtime value A ENABLE 0 1 OXFF O Disable 1 Enable OxFF Read current mode 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ DISCOVERABLE_MODE 3 HOW OUT Runtime value 4 STATUS As appropriate 5 CURMODE 0 1 0 Not discoverable 1 discoverable The module will use the parameters stored in S Registers 7 and 8 to set the inquiry scan interval and window Americas 1 800 492 2320 Option 3 29 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 5 Pairing Commands This group of commands are used to perform either incoming or outgoing pairings and to manage the trusted device database which resides in the module The trusted device database is database with a two tables each with records of two fields One field is the Bluetooth address of a paired device and the other is used to store the link key For security reasons it is not possible to put the link key on the UART hence treat it as an invisible field One database is classed a ROLLING database and is used to store new pairing information as they happen If the database is full then the oldest is discarded to make space for the latest one The other database is classed as a PERSISTANT database which stores pairing information which cannot ONLY be deleted when a new pairing is initiated to that device OR on request from
27. TATUS As appropriate 5 10 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr nO en Amen SE 12 LINKQUAL 0 255 The definitions of RSSI and LINKQUAL are paraphrased from the Bluetooth specification as follows 3 3 11 1 RSSI This value is the difference between the measured Received Signal Strength Indication RSSI and the limits of the Golden Receive Power Range see below for definition Any positive RSSI value returned by the Host Controller indicates how many dB the RSSI is above the upper limit any negative value indicates how many dB the RSSI is below the lower limit A value of zero indicates that the RSSI is inside the Golden Receive Power Range Note how accurate the dB values will be depends on the Bluetooth hardware The only requirements for the hardware are that the Bluetooth device is able to tell whether the RSSI is inside above or below the Golden Device Power Range 3 3 11 2 GOLDEN RECEIVE POWER RANGE The lower threshold level of the golden receive power range corresponds to a received power between 56 dBm and 6 dB above the actual sensitivity of the receiver The upper threshold level is 20 dB above the lower threshold level to an accuracy of 6 dB Americas 1 800 492 2320 Option 3 26 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 3 11 3 LINK QUAL Link_Quality is a value from 0 255 which represents the qual
28. aa ESRR ue 41 4 21 Unknown Commande 41 DDS SACS EE 42 4 2 3 Invalid Packet Size oo ceeccccccescececeseececseseeeeceeseeeeceesseeceesaeeeceesaeesessseeesecsaeeeeessaeesesesaeesessas 42 4 3 Connection EE 43 4 3 1 Connection Setup 43 4 3 2 INCOMING CONNECCION seie ERE Rian EEEa E E EENE 43 EE DISCONMOCE E teenies sdedieies ssannias seen cacssacetesssanaded atau cies ssasdeassan ie es EES ESA 44 ABA le el EECH TEE 44 4 3 5 Low Power Mode 45 36 SCO CONNEC EE 45 4 3 7 SEO IDISCONMEE EE 46 43 8 SCO MCOMING SETUP esien eege eege een eier 46 4 3 9 Remote Features 46 AA Miscellaneous Events 47 EA Ent EE 47 AA2 le Me ee 48 4 4 3 Local Friendly Name 48 4 4 4 Remote Friendly Name 48 4 4 5 ADC VAIUG nesies sinnini inarin saa nnan KANENN EIEE aaRS ARNAN ESEA PASKANA dd EES Ai 49 A e Ee Ne 49 4 5 1 Debug Packet ccccccccccceececeececeecececeeeeeeecaeecaeeeceaeseeeeeseaeeecaeeceeseeseescueeesseeseceesereeeaas 49 5 Miscellaneous sssssssssnnssssnnsssnnnsttnnnsttnnnsttnnnntnnnnt tn nnnt tA AnnEEAASAE EEANN EAENNE EEANN EEES SE EEANN EENE EE ASSE EE EnEn Ennen 50 5A SRegisters iea oieee Eneee E R EE ER E EAEE EA TETEA EA AEEA EAA A A A EEE ARE AEREE EORR 50 52 COMMAND amp EVENT Values 0 ccccccccceesseeceeeeceeseeeeeceeseeeeeeseeescessaeeseessaeeeeessaeeesssueeseessaeeseseaaes 52 5 3 STATUS E E 52 Americas 1 800 492 2320 Option 3 4 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech c
29. ault Discoverable Mode on power up reset Default Security Mode on power up reset 0 No Authentication No Encryption ene i A 1 Authentication No Encryption 2 Authentication Encryption 7 07 10 2550 Inquiry Scan Interval in units of msec rounded to the nearest 10ms 10ms will give 11 25 8 08 10 2550 Inquiry Scan Window in units of msec rounded to the nearest 10ms 10ms will give 11 25 9 09 10 2550 Page Scan Interval in units of msec rounded to the nearest 10ms 10ms will give 11 25 10 0A 10 2550 Page Scan Window in units of msec rounded to the nearest 10ms 10ms will give 11 25 Max frame size for lower Bluetooth stack 11 OB 0 127 Recommend this not be changed unless you are absolutely sure what you are doing 12 0C 0 30 Link supervision timeout for connections Auto Accept Mux setup If this is 1 then incoming RFCOMM channels are 13 OD U 1 automatically accepted Auto Accept Channel Setup If this is 1 incoming connections will be 14 0E o 1 automatically accepted If this is 1 EVT_CONNECTION_SETUP events are not sent to the host when an incoming connection arrives 15 OF 0 1 If this is 1 then pairing requests while in connectable mode are automatically rejected To accept pairing the host will need to be in accept Americas 1 800 492 2320 Option 3 50 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Mult
30. ce ceeeeeceaeeecaeeeeceeeeneeesaeeecsaeeeceeeeeeeeseeeeeceeecneeseteeesieeeeas 28 3 4 2 Set Discoverable Mode 29 3 5 Pairing Commande 30 ES NR Tele EC 20 3 5 2 ege E EN Ee OR lee Le EE ER 3 5 4 Trusted Database Record Coumt ss sesesetsrtrtrertrtrersrtrererereteees 33 3 5 5 Trusted Database Read Record 33 3 5 6 Trusted Database Delete Record 34 3 5 7 Trusted Database Change Twpe ttit tt it tE Et tE EEES EEES EEEEEE ESEE Entten ternene 35 Americas 1 800 492 2320 Option 3 3 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 5 8 Trusted Database Is Peer Trusite tetr rt ttr EEEE EE EEEEEEEE EEEE EErEE EErEE 35 BiG Miscellaneous COMMANAS vies isecdsnnnssdaerianntageandsadegnusbads naan ia En AE EAEE EEEa DE ean EREEREER EER she 36 3 6 1 Set Get Security Mode ssssssssseeseresetrstrittrittt attt rt ttrt tEE SEESE ESEEESEEESEEESEEESSEASE EASE EEn EESE Ee net 36 3 6 2 Get Remote Friendly Name cccccccccceeceeeseeeeneeeceeeeceeeeeeeeeeeecaeeesseeseeeeesseesseesstseenaes 36 3 6 3 Get Local Friendly Name 38 3 6 4 Set Local Friendly Name ic cccsccccccesesccasscaueeshegecenachessnachaecendddeseetr DEENEN 38 3 6 5 Get Digital Analog MO 39 EES el Ce E A0 A Module TC 41 A Gy EVENS en e S 41 4 1 1 Inquiry Resuht AEEEAEEEEEEEEEEEESEEE SEES SEES EEES EEES REESE Ennen neen 41 42 intonation EVENTS eis ansieae aeae Ea Aere AA A a TE
31. chnologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 0 7 Chip Designation E g BC2 EXT Chip designation null terminated string 0 Physical Medium 0 Bluetooth 1 7 Reserved 0 CH 0 1 GOLDEN_RECEIVE_RANGE 0 65535 Golden Receive Range 2 3 RECEIVE_LOWER_LIMIT 32768 32767 Golden Receive Lower limit 4 5 RECEIVE_UPPER_LIMIT 32768 32767 Golden Receive Upper limit 6 7 Reserved Any value Ezurio private Use In dBm This is a signed 16 bit value 0 1 TX_POWER_IN_DBM 32768 32767 Offset 0 is msb and offset 1 is lsb 0 1 Max Output Gain 0 65535 3 2 Configuration Commands This group of commands are used to configure the module 3 2 1 Read S Register The module is configured using integer values which can be stored in non volatile memory similar to the S registers provided in the single point AT module Valid register numbers are in the range O to 255 Registers O to 127 generally specify parameters which can be stored in a 16 bit storage location and registers 128 to 255 can store 32 bit values See section S Registers in chapter Miscellaneous for a full list of all registers The following command is used to read the current value of the S register REGNO Americas 1 800 492 2320 Option 3 3 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www laird
32. d in the EVT_SCO_CONNECT message 02 PCM channel and valid handle values are 0 to 2 inclusive which map to the slots on the pcm highway 03 Reserved for future use Americas 1 800 492 2320 Option 3 27 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 3 13 Stream Disconnect There is a concept of pipes of data where each pipe is a sink and a source This command is used to disconnect a sink which is a consumer of data 0 LENGTH 10 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_STREAM_DISCONNECT 3 FLOW_IN Runtime value 4 TYPE See note 1 below Source Stream Type 5 6 HANDLE 2 byte handle id Source handle 7 TYPE See note 1 below Sink Stream Type 8 9 HANDLE 2 byte handle id Sink handle 0 LENGTH 8 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_STREAM_DISCONNECT 3 HOW OUT Runtime value 4 STATUS As appropriate 5 TYPE See note 1 below Sink Stream Type 6 7 HANDLE 2 byte handle id Sink handle The STATUS value will be MPSTATUS_OK if the Source was successfully disconnected from the Sink 3 4 Inquiry Commands This group of commands are used to performing inquiries and putting the module into discoverable mode 3 4 1 Inquiry Request This command is used to perform a Bluetooth inquiry 0 LENGTH 7 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_INQUIRY_REQ 3 FLOW_
33. e timeout EVT_LINK_KEY bdaddr Lag RSP_PAIR_INITIATE 3 5 2 Pair Accept This command is used to put the module into a mode such that it accepts a peer initiated pairing While in this mode it is not possible to initiate pairing inquiry or make connections In addition any incoming connections will be silently rejected 0 LENGTH 22 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_PAIR_ACCEPT 3 FLOW_IN Runtime value 4 TIMEOUT 5 120 Pairing timeout in seconds 5 21 PIN 17 byte string array ER 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_PAIR_ACCEPT 3 HOW OUT Runtime value 4 STATUS As appropriate If pairing is successful the event message EVT_LINK_KEY will be sent to the host before the response to close the procedure as shown in the message sequence chart below Americas 1 800 492 2320 Option 3 31 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide Note Pair Accept will fail if there are any existing open connections The status byte in the response will have an appropriate value HOST MODULE CMD_PAIR_ACCEPT pincode timeout incoming connection EVT_LINK_KEY bdaddr RSP_PAIR_ACCEPT 3 5 3 PinCode This command is used to send a pincode in response to an EVT_PINCODE_REQUEST message 0 LENGTH 27 Fixed 1 CHANNEL 0
34. eeeeaeseeeanseaeeeeeeeeeeeeeeeeeeaeaeeeueeeeeeeeeeeeteeeteteneeenss 9 3 Host Commandibesponses NEEN 10 3 1 Information Commande 10 3 1 1 NO Operation 10 3 1 2 Get Connectable Discoverable Security Modes erra 11 3 1 3 Read Local Bluetooth Address 11 3 1 4 0K 00 0 lt 10 0 6 arnnrirneianan niaka ennen iE aE aE E AE AEAN AENEA Dian 12 3 2 Configuration Commande tett At tett EtA AN EEEE ENEA EEEEEEEEEE NEEE EEEEE EEEE EE EEEE EE EEEE reret 13 32 P Read D EE 13 3 2 2 Write S Register 14 323 ET 15 3 2 4 Default S Register 15 3 2 5 Read Communications barameters einir inken e ennn EAEAP EEEE EEE EE EEEE EEEE EEEE EEEE eeaeee 16 3 2 6 Write Communications Parameters ccccecccceeccececececececeseseseseseeesetsrtrertrsrerertrererererees 16 3 3 Connection Commandes 17 3 3 1 Set Connectable Mode 17 3 3 2 Service INCOMING Copnpnechon ttti rt tErrE ESEAS EEEn EEEn EEn nren nEnn Erne Er net 18 3 3 3 Make Outgoing Connection 19 33A Drop CONMECHON iea A E E EES 20 3 35 Set Modem H KIC 20 33 6 SCO GOMMO EE 21 3 3 7 SCO RTE ell 22 338 SCO INCOMING SETUD EE 23 E WEITEN 24 EN lg REQUEST EE 25 3 3 11 RSS and Link Quality eee ccceceeceseeececesaeeeeeeseeeseeeseeeeessaeeseeesaeesessseeesssseeeesssieeeeseaaes 26 33 12 Stream ele EE 27 3 3 13 Stream Disconnert cece cecececececcecececececes cece esererssrsrsssrsssessssrsssssssssrstsesesnanenenanenananans 28 3 4 EE EE 28 3 4 1 Inquiry Request 2 eee eeeece cece ce cecee ce
35. en Bluetooth RFCOMM connection Response packets shall always be as a result of a command packet and event packets are asynchronously sent to the host as and when required The host shall ensure that it is always ready to accept response and event packets especially event packets as they can be sent at any time 2 2 1 Response Packets The format for response packets is as per the table below 0 LENGTH Total length of this packet including this octet CHANNEL Always 0 2 COMMAND Echoed from the command packet Shall be gt 0 Bit O to 6 specify a mask A clear bit means the host should NOT send any more 3 FLOW_OUT packets to that corresponding data channel Bit 7 is always O and will be used as an extension bit in the future 4 STATUS O means success N M DATA Data as required and has meaning specific to the response for COMMAND Americas 1 800 492 2320 Option 3 7 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 2 2 2 Event Packets The format for status packets is as per the table below 0 LENGTH Total length of this packet including this octet 1 CHANNEL Always 0 2 EVENT Described later Bit O to 6 specify a mask A clear bit means the host should NOT send any more 3 FLOW_OUT packets to that corresponding data channel Bit 7 is always O and will be used as an extension bit in the future N M DATA Data as required
36. ey survive a power cycle 0 LENGTH 4 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_STORE_SREG 3 FLOW_IN H Runtime value 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_STORE_SREG_ 3 HOW OUT Runtime value 4 STATUS As appropriate 3 2 4 Default Ss Registers This command is used to force all S register values to factory default 0 LENGTH 4 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ DEFAULT_SREG 3 FLOW_IN 7 Runtime value 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ DEFAULT_SREG_ 3 HOW OUT Runtime value 4 STATUS As appropriate Americas 1 800 492 2320 Option 3 15 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 2 5 Read Communications Parameters This command is used to read the communications settings as stored in non volatile storage 0 LENGTH 4 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ READ_COMMSPARM 3 FLOW_IN H Runtime value 0 LENGTH Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ READ_COMMSPARM 3 HOW OUT Runtime value 4 STATUS As appropriate 5 8 BAUD 1200 921600 Offset 5 is the MSB and offset 9 the LSB 9 STOPBITS 1 2 Stop bits 10 PARITY 0 2 0O None 1 Odd 2 Even 11 FLOW 1 1 CTS RTS handshaking At the time of writing only CTS RTS handshaking is available It cannot be disabled 3 2 6 W
37. f incoming and outgoing packets The term incoming will henceforth imply packets sent by the host to the module and outgoing in the reverse direction That is the direction terminology is module centric All packets have octet granularity When an octet is described as containing bit fields it shall be taken that bit O is the least significant bit and bit 7 is the most significant bit Subfields in the packet which require multiple octets shall be ordered so that the lowest significant octet is transmitted LAST over the transport media unless specifically described otherwise For example a 16 bit word value will require 2 octets within the packet and the first octet will correspond to the upper byte Similarly a 6 byte Bluetooth address shall be transported most significant byte first If the order is reversed then it will be specifically highlighted in the description of appropriate packets Subfields which are data arrays shall be described with the TP operator in descriptions which come in subsequent chapters Apart from data packets all command respond and event packets are of fixed size If there is enough data to fill a packet then the packet is filled with Os The protocol and packet format is optimised to ensure maximum data throughput via the virtual machine which processes these packets and as such shall allow a maximum of 3 channels It is possible to have all 3 channels in a single slave connection to multiple prof
38. g Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 4 3 3 Disconnect This event is used to inform the host that a connection has been dropped by the remote device 0 LENGTH 6 1 CHANNEL 0 2 EVENT EVT_ DISCONNECT 3 HOW OUT Runtime value 4 CHANNEL 1 7 Channel number 5 REASON 0 255 As per the table below The reason value is specified in the Bluetooth specification and are reproduced here for your convenience as follows please note that values in the range OxFO to OxFF are custom values defined for this implementation and do not appear in the Bluetooth specification 0x01 Unknown HCI Command 0x02 No Connection 0x03 Hardware Failure 0x04 Page Timeout 0x05 Authentication Failure 0x06 Key Missing 0x07 Memory Full 0x08 Connection Timeout 0x09 Max Number Of Connections Ox0A Max Number Of SCO Connections To A Device Ox0B ACL connection already exists Ox0C Command Disallowed Ox0D Host Rejected due to limited resources OxOE Host Rejected due to security reasons OxOF Host Rejected due to remote device is only a personal device 0x10 Host Timeout 0x11 Unsupported Feature or Parameter Value 0x12 Invalid HCI Command Parameters 0x13 Other End Terminated Connection User Ended Connection 0x14 Other End Terminated Connection Low Resources 0x15 Other End Terminated Connection About to Power Off 0x16 Connection Terminated by Local Host 0
39. iles In recognition of the fact that a host may have limited RAM the command response will be designed to minimise the size of response packets This means the number of commands may seem unduly large where multiple command packets will be required to get a set of data where it would logically have been prudent to send all the data in one large response packet The design aims to optimise throughput over the air The following sections describe the packets in detail 2 1 Host to Module Packets These are packets used to convey commands to the module or raw data to be sent over an open Bluetooth RFCOMM connection 2 1 1 Command Packets The format for command packets is as per the table below 0 LENGTH Total length of this packet including this octet 1 CHANNEL Always 0 2 COMMAND Described in the next chapter Bit O to 6 specify a mask A clear bit means the module should NOT send any more packets to that corresponding data channel Bit 7 is always O and will be used as an extension bit in the future It is assumed that the host will always be able to receive a response or status packet 3 FLOW_IN Data as required and has meaning specific to COMMAND For example if the AN DATA command is to make a connection to a peer device then it will be at least a 6 octet array specifying the Bluetooth address of the peer Americas 1 800 492 2320 Option 3 6 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 06
40. ipoint Firmware User s Guide pairing mode which is initiated by the CMD_PAIR_ACCEPT host command 16 10 2 120 For outgoing connection attempts this is the timeout before the attempt is abandoned Auto Accept incoming SCO channel If this is 1 then incoming SCO 17 11 0 2 channels are auto accepted if set to 2 then eSCO is auto accepted Set to 0 to get the host to accept reject the connection Auto Route 17 SCO channel to PCM Slot 0 WE S See Note 1 below 19 13 1 4 BootMode Default is 1 which sets the unit up for a Motorola codec in master mode A value of 3 sets it up for the OKI7702 5 in master mode Maximum RF transmit power 20 14 27 6 To read actual power at any moment read it back via CMD_INFORMATION subcommand 5 21 15 0 A Output gain of Codec A X is dependent on csr stack build and use lt 15 CMD_INFORMATION sub command 06 to get actual maximum value 22 16 o A Output gain of Codec B X is dependent on csr stack build and use lt 15 CMD_INFORMATION sub command 06 to get actual maximum value GPIO Direction register Setting a bit to 1 will configure the GPIO pin as an 23 17 0 Ox01FF output and CMD SET JO command packet can be used to control the State 24 18 0 1 Option field for Headset profile service record 25 19 0 63 Option field for Handsfree profile service record 26 1A 0 1 If set to 1 master slave role switch requests from a peer will be denied Some events sen
41. isecs Offset 12 is MSB 0 LENGTH 6 Fixed 1 CHANNEL U Fixed 2 COMMAND CMD_PARK_REQUEST 3 HOW OUT Runtime value 4 STATUS As appropriate The STATUS value will be MPSTATUS_OK if the request was successfully submitted to the stack Minimum value of MIN_INT is MIN_PARK_MININTERVAL_MSEC as defined in the header file BmHostProtocol H 10ms at the time of writing this manual Americas 1 800 492 2320 Option 3 25 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide Minimum value of MAX_INT is MIN_PARK_MAXINTERVAL_MSEC as defined in the header file BmHostProtocol H Oms at the time of writing this manual Maximum value of MAX_INT is MAX_PARK_MAXINTERVAL_MSEC as defined in the header file BmHostProtocol H 40000ms at the time of writing this manual Maximum value of MIN_INT cannot exceed the value specified in MAX_INT 3 3 11 RSSI and Link Quality This command is used to obtain the RSSI and Link Quality values for a given open connection This is a parameter associated with the ACL connection to a peer device and has no meaning with channel ids 0 LENGTH 10 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_RSSI_LINKQUAL 3 FLOW_IN 2 Runtime value 4 9 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr U LENGTH Fixed 1 CHANNEL U Fixed 2 COMMAND CMD_RSSI_LINKQUAL 3 HOW OUT Runtime value 4 S
42. ital input lines and optionally request an analogue input reading This response packet contains 2 octets containing the digital input states If an analogue input reading is requested then the ADC reading in the range 0 1800 will be supplied in an EVENT_ADC event 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_GET_IO 3 FLOW_IN H Runtime value l 0 Onboard Digital Vo R ide S 1 I O Mapped as GPIO pins 0 No ADC access 5 analogld 0 2 1 ANAL_1 MAIO_0 2 ANAL_2 MAIO_1 Americas 1 800 492 2320 Option 3 39 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 0 LENGTH Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_GET_IO 3 HOW OUT Runtime value 4 STATUS As appropriate 5 digld 0 Echoed from command packet 6 7 digIn 2 Digital inputs O to 15 Note If analogId field in the command is 1 or 2 and EVENT_ADC will be generated when the ADC is read and available 3 6 6 Set Digital I O This command is used to control the states of up to 16 digital output lines The appropriate gpio pin will have been set to an output pin via S Register 23 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SET_IO 3 FLOW_IN Runtime value 4 iold 1 1 I O Mapped as GPIO pins 5 6 ioVal 2 0000 FFFF 0 LENGTH Fixed 1 CHANNEL 0 Fixed 2 COMMAND CM
43. ity of the link between two Bluetooth devices The higher the value the better the link quality is Each Bluetooth module vendor will determine how to measure the link quality In the case of CSR this value is a measure of BER Bit Error Rate 3 3 12 Stream Connect There is a concept of pipes of data where each pipe is a sink and a source For example when an SCO channel is established it can be a source or sink of data Likewise the Bluetooth module has a PCM interface which has 3 slots and each slot can be viewed as a pipe too This command is used to connect a source of data to a sink which consumes that data 0 LENGTH 10 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_STREAM_CONNECT 3 FLOW_IN H Runtime value 4 TYPE See note 1 below Source Stream Type 5 6 HANDLE 2 byte handle id Source handle 7 TYPE See note 1 below Sink Stream Type 8 9 HANDLE 2 byte handle id Sink handle 0 LENGTH 11 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_STREAM_CONNECT 3 HOW OUT Runtime value 4 STATUS As appropriate 5 TYPE See note 1 below Source Stream Type 6 7 HANDLE 2 byte handle id Source handle 8 TYPE See note 1 below Sink Stream Type 9 10 HANDLE 2 byte handle id Sink handle The STATUS value will be MPSTATUS_OK if the Source was successfully connected to the Sink Note 1 Source or Sink Stream Type values are 01 SCO channel and the handle value is as returne
44. luetooth addr echoed from the command Americas 1 800 492 2320 Option 3 34 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 5 7 Trusted Database Change Type This command is used to transfer a record to the database specified 0 LENGTH 11 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_TRUSTED_DB_CHANGETYPE 3 FLOW_IN H Runtime value 4 DBTYPE 0 1 5 10 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr 0 LENGTH 12 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_TRUSTED_DB_CHANGETYPE 3 HOW OUT Runtime value 4 STATUS As appropriate 5 DBTYPE 0 1 Echoed from command Bluetooth addr echoed from the 6 11 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 command 3 5 8 Trusted Database Is Peer Trusted This command is used to check if a device is trusted 0 LENGTH 10 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ TRUSTED_DB_ISTRUSTED 3 FLOW_IN Runtime value 4 9 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr 0 LENGTH 11 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ TRUSTED_DB_ISTRUSTED 3 HOW OUT Runtime value 4 STATUS As appropriate 5 10 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr echoed from the command The STATUS value will be MPSTATUS_OK if the device is trusted any other value means not trusted Americas 1 800 492 2320 Option 3 35 Laird Technologies Europe 44 1628 8
45. ly established as shown in the message sequence chart below HOST MODULE Incoming connection EVT_CONNECTION_SETUP bdaddr CMD_CONNECTION_SETUP bdaddr accept handle RSP_CONNECTION_SETUP handle _Connection Established EVT_INCOMING_CONNECTION channelid bdaddr uuid Note If auto accept was specified when the module was put into connectable mode then for incoming connections there will only be an EVT_INCOMING_CONNECTION message Americas 1 800 492 2320 Option 3 18 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide HOST MODULE Incoming connection EVT_INCOMING_CONNECTION channelid bdaddr uuid 3 3 3 Make Outgoing Connection This command is used to make an outgoing connection to a RFCOMM based profile in the remote peer Some peers have more than one instance of a given profile For example some mobile phones advertise two serial port profiles The make connection message has an instance field which is used to specify which instance of the remote profile the connection should be made to 0 LENGTH 13 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ MAKE CONNECTION 3 FLOW_IN Runtime value 4 HANDLE Hier al ol value the E is echoed by the module in the 5 10 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address Uuid of the profile to connect to Offset 11 is 1
46. n exit sniff mode HOST MODULE S Register 17 0 L EVT SCO_INCOMING_SETUP bdaddr handle S00 Incoming CMD_SCO_INCOMING_SETUP bdaddr handle accept Le RSP_SCO_INCOMING_SETUP GE gt SCO Accept p EVT_SCO_CONNECT bdaddr handle fe EEN Ee y y HOST MODULE S Register 17 1 ra SCO Incoming Eo SCO Accept SE Establish e EVT_SCO_CONNECT bdaddr handle SGO Established y Y The response packet will be received immediately The host shall wait for an EVT_LOWPOWER_MODE event for actual notification of success or failure 0 LENGTH 18 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SNIFF_REQUEST 3 FLOW_IN H Runtime value 4 9 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address 10 11 ATTEMPT Sniff Attempt Millisecs Offset 10 is MSB 12 13 TIMEOUT Sniff Timeout Millisecs Offset 12 is MSB 14 15 MIN_INT Sniff Minimum Interval Millisecs Offset 14 is MSB 16 17 MAX_INT Sniff Maximum Interval Millisecs Offset 16 is MSB 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SNIFF_REQUEST 3 HOW OUT Runtime value 4 STATUS As appropriate Americas 1 800 492 2320 Option 3 24 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide The STATUS value will be MPSTATUS_OK if the request was successfully submitted to the stack Minimum value of ATTEMPT is MIN_SNIFF_ATTEMPT_MSEC a
47. om bluetooth BISM II Multipoint Firmware User s Guide 1 INTRODUCTION This document describes a packet based messaging interface which is used by a host to send commands receive responses and exchange multiplexed data with the blu2i Multipoint Module henceforth described as the Module The Module consists of the same hardware as that used for the single point AT blu2i module described elsewhere Whereas the latter only allows one to one connection the module described here allows simultaneous connections to a maximum of 3 slaves It also allows connections to multiple profiles to one or more slaves Hence this document adopts a concept of channels instead of slave connections The term host in this document is taken to mean any entity which is a source of command messages sink for response event messages and both source and sink for multiplexed data packets To further eliminate any confusion when the term command message is used it implies a message from the host to the module and likewise response message is used to imply a message from the module to the host This document does NOT describe how the packets are physically exchanged between the host and the module The transport medium will be either UART or USB It also does NOT describe the format of any envelope that may be required to reliably and quickly transfer the message packet between the host and module This implies that when the packets proposed in
48. ong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 4 3 Connection Events This group of events are connection related 4 3 1 Connection Setup This event is used to inform the host that a remote device is requesting a connection The host shall respond with a CMD_CONNECTION_SETUP with an accept or reject flag 0 LENGTH 12 1 CHANNEL 0 2 EVENT EVT_ CONNECTION_SETUP 3 HOW OUT Runtime value 4 9 BDADDR 6 _ Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address of device requesting connection 0x1101 SPP 10 11 un Server profile uuid the peer Ox1108 HEADSET wishes to connect to 0x1112 AUDIO GATEWAY 0x1103 DUN The UUID field tells the host to which server profile the peer wishes to connect to 4 3 2 Incoming Connection This event is used to inform the host that an incoming connection has been established 0 LENGTH 13 1 CHANNEL 0 2 EVENT EVT_ CONNECTION_SETUP 3 HOW OUT Runtime value 4 CHANNEL TaZ Channel ID to be used to send receive data 5 10 BDADDR 6 _Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address of device requesting connection 0x1101 SPP 11 12 un Server profile uuid the peer 0x1108 HEADSET wishes to connect to 0x1112 AUDIO GATEWAY 0x1103 DUN The UUID field tells the host to which server profile the peer has connected to Americas 1 800 492 2320 Option 3 43 Laird Technologies Europe 44 1628 858 940 Hon
49. rite Communications Parameters This command is used to write new communications settings to non volatile storage 0 LENGTH H Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_WRITE_COMMSPARN 3 FLOW_IN 2 Runtime value 4 7 BAUD 1200 921600 Offset 5 is the MSB and offset 9 the LSB 8 STOPBITS 1 2 Stop bits 9 PARITY 0 2 O None 1 Odd 2 Even 10 FLOW 1 1 CTS RTS handshaking Americas 1 800 492 2320 Option 3 16 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_WRITE_COMMSPARN 3 HOW OUT Runtime value 4 STATUS As appropriate Note The communication parameters come into effect after a reset power cycle 3 3 Connection Commands This group of commands are used to establish and break connections 3 3 1 Set Connectable Mode This command enables disables connectable mode and specifies auto accept parameters for channels muxs 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ CONNECTABLE_MODE 3 FLOW_IN Runtime value 0 Disable 1 Enable S ENABLE Cs te UREE OxFF Read current mode Bit 0 Set to auto accept channel setup Bit 1 Set to auto accept mux setup S ALLEN Bemas CURRENTLY IGNORE FORCED TO 1 INTERNALLY 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ CONNECTABLE_MODE 3 HOW OUT
50. s Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SCO_CONNECT 3 HOW OUT Runtime value 4 STATUS As appropriate The STATUS value will be MPSTATUS_OK if the request was successfully submitted to the stack When the SCO channel is established an EVENT called SCO Connect will be sent to the host which will contain a handle to be used to disconnection requests HOST MODULE CMD_SCO_CONNECT bdaddr RSP_SCO_CONNECT poo ee eonnieet Med Sec ish EVT_SCO_CONNECT bdaddr handle ee 3 3 7 SCO Disconnect This command is used to disconnect an existing SCO channel identified by a handle which is provided in the SCO establishment event see Event SCO Connect 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SCO_DISCONNECT 3 FLOW_IN Runtime value 4 5 HANDLE 2 byte SCO handle Handle 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_SCO_DISCONNECT 3 HOW OUT Runtime value 4 STATUS As appropriate The STATUS value will be MPSTATUS_OK if the message was submitted to the lower stack When the SCO channel is cleared an EVENT called SCO Disconnect will be sent to the host Americas 1 800 492 2320 Option 3 22 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II M
51. s command is used to read the Bluetooth address of the ITEMNO pairing in the database specified counted from the top ITEMNO is indexed from 1 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_TRUSTED_DB_READ 3 FLOW_IN Runtime value 0 ROLLING DATABASE SES Ge 1 PERSISTANT DATABASE 5 ITEMNO 1 N Item number to read Americas 1 800 492 2320 Option 3 as Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide Offset Field Value Comments 0 LENGTH 13 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_TRUSTED_DB_READ 3 HOW OUT Runtime value 4 STATUS As appropriate 5 DBTYPE 0 1 Echoed from command 6 ITEMNO 1 N Echoed from command Bluetooth addr 7 12 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Will be all O s if the item specified does not exist 3 5 6 Trusted Database Delete Record This command is used to delete a pairing from the databases It is not necessary to specify the database type as any type of instance is deleted 0 LENGTH 10 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ TRUSTED_DB_DELETE 3 FLOW_IN Runtime value 4 9 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr of device to be unpaired 0 LENGTH 11 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ TRUSTED_DB_DELETE 3 HOW OUT Runtime value 4 STATUS As appropriate 5 10 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 B
52. s defined in the header file BmHostProtocol H 12ms at the time of writing this manual Minimum value of TIMEOUT is MIN_SNIFF_TIMEOUT_MSEC as defined in the header file BmHostProtocol H 12ms at the time of writing this manual Minimum value of MIN_INT is MIN_SNIFF_MININTERVAL_MSEC as defined in the header file BmHostProtocol H 100ms at the time of writing this manual Minimum value of MAX_INT is MIN_SNIFF_MAXINTERVAL_MSEC as defined in the header file BmHostProtocol H 100ms at the time of writing this manual Maximum value of MAX_INT is MAX_SNIFF_MAXINTERVAL_MSEC as defined in the header file BmHostProtocol H 2000ms at the time of writing this manual Maximum value of MIN_INT cannot exceed the value specified in MAX_INT Maximum values of ATTEMPT and TIMEOUT cannot exceed value of MIN_INT 3 3 10 Park Request This command is used to enter or exit PARK mode for a given open connection If either MIN_INT or MAX_INT value is set to 0 then the device will take that to mean exit park mode The response packet will be received immediately The host shall wait for an EVT_LOWPOWER_MODE event for actual notification of success or failure 0 LENGTH 14 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_PARK_REQUEST 3 FLOW_IN 2 Runtime value 4 9 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address 10 11 MIN_INT Park Minimum Interval Millisecs Offset 10 is MSB 12 13 MAX_INT Park Maximum Interval Mill
53. t to the host have to be enabled by setting appropriate bits 27 1B 0 in the register Bit O Enable REMOTE_FEATURES event Primer for changing to AT mode See document blu2i AT and Multipoint 126 7E 9 SE Mode Change od for more details 127 7F 0 OxFFFF Change to AT mode using value 0x0100 128 80 0 OxFFFFFF Module s Class of Device Notes 1 SReg 18 is read by the firmware at reset Hence after setting this register a reset is required for it to be effective This means the S Register set MUST be committed to non volatile memory before initiating a reset The S Registers are stored to non volatile memory using the command CMD_STORE_SREG Americas 1 800 492 2320 Option 3 Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth 51 Laird Technologies BISM II Multipoint Firmware User s Guide 5 2 COMMAND amp EVENT values The following is a listing of a snapshot of the file BMHOSTPROTOCOL H at the time of writing this document Ezurio does NOT guarantee that this listing will be kept up to date For development purposes please send a request to multipoint Ezurio com for the latest version of the C header file
54. tech com bluetooth BISM II Multipoint Firmware User s Guide 0 LENGTH 5 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_READ_SREG 3 FLOW_IN Runtime value 4 REGNO 0 to 255 0 LENGTH 10 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_READ_SREG 3 HOW OUT Runtime value 4 STATUS OK 5 REGNO 0 to 255 Echoed from Command 6 9 REGVALI Botte REGVAL O is the most significant octet 3 2 2 Write S Register This command is used to write a new value to the S register REGNO See section S Registers in chapter Miscellaneous for a full list of all registers 0 LENGTH 9 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_WRITE_SREG 3 FLOW_IN H Runtime value Registers 250 to 255 inclusive are used for 4 REGNO 0 to 255 ee upgrade purpose DO NOT WRITE TO THESE REGISTERS 5 8 REGVALI New Register Value REGVAL O is the most significant octet 0 LENGTH 10 1 CHANNEL 0 2 COMMAND CMD_WRITE_SREG Americas 1 800 492 2320 Option 3 14 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 HOW OUT Runtime value STATUS As appropriate 5 REGNO O to 255 Echoed from Command 6 9 REGVAL Register Value REGVAL O is the most significant octet 3 2 3 Store S Registers This command is used to save the current S register value in non volatile memory so that th
55. the name is to be passed up to it via these events from the offset it also specifies This implies that in a memory constraint environment it will be possible to relay the name to the host using multiple commands For example if the host has space for only 10 bytes and a peer happens to have a very long name the host can ask for 10 byte fragments of the name over multiple get name requests Americas 1 800 492 2320 Option 3 36 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide U LENGTH 13 Fixed 1 CHANNEL U Fixed 2 COMMAND CMD_GET_REM_FNAME 3 FLOW_IN Runtime value 4 9 BDADDR Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth addr 10 TIMEOUT 1 120 Timeout in seconds 11 START n Offset into the friendly name string 12 MAXBYTES m Max characters to read U LENGTH 8 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_GET_REM_FNAME 3 HOW OUT Runtime value 4 STATUS As appropriate 5 NAMELEN 0 248 Actual size of the friendly name 6 START n Echoed from the command 7 SENTLEN S Total number of bytes sent Note SENTLEN could be less than MAXBYTES It can happen if there is no space in the modules TX buffer to send events HOST MODULE CMD_REM_FNAME bdaddr timeout start 0 maxbytes 25 Got Friendly Name 47 bytes EVT_REM_FNAME index 0 len 10 EVT_REM_FNAME index 10 len 10 2
56. this document are processed they are assumed not to contain any errors 1 1 Flow control amp Data Integrity It must be recognised that the transport mechanism will be streaming in nature If the transport medium is USB then flow control and data integrity is inherently provided by the USB protocol If UART is the medium then it shall be assumed that there will be a 5 wire interface RX TX CTS RTS and GND Any host attached to the UART of the module shall strictly observe CTS RTS hardware handshaking Packet data integrity may or may not be provided depending on the build It is expected that for a UART transport media guaranteeing data integrity will be at the severe expense of data throughput 1 2 Maximum Packet Size Consideration Ezurio acknowledges that hosts attaching to the module may have limited RAM random access memory resource and so the module makes provision for this by guaranteeing not to send packets larger than a certain negotiated size See S Reg 2 in Chapter 5 However it is assumed that there will be a certain minimum packet size 16 that the host SHALL be capable of coping with The host must guarantee that there is space for at least 2 packet in the receive buffer Americas 1 800 492 2320 Option 3 5 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 2 PACKET GENERAL FORMAT This section describes the general format o
57. ultipoint Firmware User s Guide HOST MODULE PRE EXISTING SCO CHANNEL CMD_SCO_DISCONNECT handle m LL RSP_SCO_DISCONNECT EENS EVT_SCO_DISCONNECT BEER y y 3 3 8 SCO Incoming Setup This command is used to accept or reject an incoming SCO channel and is used in response to a SCO Incoming Setup event The SCO Incoming Setup event in turn will only be sent to the host if S Reg 17 is 0 By default S Reg 17 is 1 and so incoming SCO channel setup will be automatically accepted 0 LENGTH 13 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_CONTROLMODEMLINES 3 HOW IN Runtime value 49 BDADDRI Naplo 1 Uap 2 Lap 3 4 5 Bluetooth address echoed from EVT_SCO_INCOMING_SETUP 2 byte handle echoed from EVT_SCO_INCOMING_SETUP O to reject 1 to accept SCO and 2 to 10 11 HANDLE SCO handle 12 ACCEPT 0 1or2 accept eSCO 0 LENGTH 6 Fixed 1 CHANNEL 0 Fixed 2 COMMAND CMD_ CONTROLMODEMLINES 3 HOW OUT Runtime value 4 STATUS As appropriate The BDADDR and HANDLE fields MUST be copied from the EVT_SCO_INCOMING_SETUP packet Americas 1 800 492 2320 Option 3 23 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 3 3 9 Sniff Request This command is used to enter or exit Sniff mode for a given open connection If the ATTEMPT value is set to O then the device will take that to mea
58. x17 Repeated Attempts OxFF High probability that the remote device went out range for longer than the link supervision timeout or was powered down 4 3 4 Modem Status This event is used to convey modem status signals originating from the peer device 0 LENGTH 6 1 CHANNEL 0 2 EVENT EVT_ MODEM_STATUS 3 HOW OUT Runtime value Americas 1 800 492 2320 Option 3 44 Laird Technologies Europe 44 1628 858 940 Hong Kong 852 2923 0610 www lairdtech com bluetooth BISM II Multipoint Firmware User s Guide 4 CHANNEL 1 7 Channel ID of an open channel Bit 0 DSR state Bit 1 CTS state 5 MODEMSIG Bit Mask Bit 2 DCD state Bit 3 RI state 6 BREAKSIG 0 For future implementation 4 3 5 Low Power Mode This event is used to inform the host that the connection related to the Bluetooth address specified has changed its low power mode to one of ACTIVE HOLD SNIFF or PARK The new mode shall assumed to be the case ONLY if the status field has the value MPSTATUS_OK 0 0 LENGTH 12 1 CHANNEL 0 2 EVENT EVT_LOW_POWER_MODE 3 HOW OUT Runtime value 4 STATUS 0 ok 5 10 BDADDR 6 Nap 0 1 Uap 2 Lap 3 4 5 Bluetooth address 0 ACTIVE 1 HOLD 11 MODE New Mode 2 SNIFF 3 PARK 4 3 6 SCO Connect This event is used to inform the host thata SCO connection has been established 0 LENGTH 15 1 CHANNEL 0 2 EVENT EVT_ SCO_CONNECT 3 HOW OUT

BISM-II Multipoint Firmware

Contents

Download Pdf Manuals

Related Search

Related Contents