avrcp.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2015-2016 Intel Corporation
 * Copyright (C) 2024 Xiaomi Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AVRCP_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_AVRCP_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_AVRCP_COMPANY_ID_SIZE          (3)
#define BT_AVRCP_COMPANY_ID_BLUETOOTH_SIG (0x001958)

typedef enum __packed {
        BT_AVRCP_CAP_COMPANY_ID = 0x2,
        BT_AVRCP_CAP_EVENTS_SUPPORTED = 0x3,
} bt_avrcp_cap_t;

typedef enum __packed {
        BT_AVRCP_EVT_PLAYBACK_STATUS_CHANGED = 0x01,
        BT_AVRCP_EVT_TRACK_CHANGED = 0x02,
        BT_AVRCP_EVT_TRACK_REACHED_END = 0x03,
        BT_AVRCP_EVT_TRACK_REACHED_START = 0x04,
        BT_AVRCP_EVT_PLAYBACK_POS_CHANGED = 0x05,
        BT_AVRCP_EVT_BATT_STATUS_CHANGED = 0x06,
        BT_AVRCP_EVT_SYSTEM_STATUS_CHANGED = 0x07,
        BT_AVRCP_EVT_PLAYER_APP_SETTING_CHANGED = 0x08,
        BT_AVRCP_EVT_NOW_PLAYING_CONTENT_CHANGED = 0x09,
        BT_AVRCP_EVT_AVAILABLE_PLAYERS_CHANGED = 0x0a,
        BT_AVRCP_EVT_ADDRESSED_PLAYER_CHANGED = 0x0b,
        BT_AVRCP_EVT_UIDS_CHANGED = 0x0c,
        BT_AVRCP_EVT_VOLUME_CHANGED = 0x0d,
} bt_avrcp_evt_t;

typedef enum __packed {
        BT_AVRCP_CTYPE_CONTROL = 0x0,
        BT_AVRCP_CTYPE_STATUS = 0x1,
        BT_AVRCP_CTYPE_SPECIFIC_INQUIRY = 0x2,
        BT_AVRCP_CTYPE_NOTIFY = 0x3,
        BT_AVRCP_CTYPE_GENERAL_INQUIRY = 0x4,
} bt_avrcp_ctype_t;

typedef enum __packed {
        BT_AVRCP_RSP_NOT_IMPLEMENTED = 0x8,
        BT_AVRCP_RSP_ACCEPTED = 0x9,
        BT_AVRCP_RSP_REJECTED = 0xa,
        BT_AVRCP_RSP_IN_TRANSITION = 0xb,
        BT_AVRCP_RSP_IMPLEMENTED = 0xc, 
        BT_AVRCP_RSP_STABLE = 0xc,      
        BT_AVRCP_RSP_CHANGED = 0xd,
        BT_AVRCP_RSP_INTERIM = 0xf,
} bt_avrcp_rsp_t;

typedef enum __packed {
        BT_AVRCP_SUBUNIT_TYPE_PANEL = 0x09,
        BT_AVRCP_SUBUNIT_TYPE_UNIT = 0x1f,
} bt_avrcp_subunit_type_t;

typedef enum __packed {
        BT_AVRCP_OPID_SELECT = 0x00,
        BT_AVRCP_OPID_UP = 0x01,
        BT_AVRCP_OPID_DOWN = 0x02,
        BT_AVRCP_OPID_LEFT = 0x03,
        BT_AVRCP_OPID_RIGHT = 0x04,
        BT_AVRCP_OPID_RIGHT_UP = 0x05,
        BT_AVRCP_OPID_RIGHT_DOWN = 0x06,
        BT_AVRCP_OPID_LEFT_UP = 0x07,
        BT_AVRCP_OPID_LEFT_DOWN = 0x08,
        BT_AVRCP_OPID_ROOT_MENU = 0x09,
        BT_AVRCP_OPID_SETUP_MENU = 0x0a,
        BT_AVRCP_OPID_CONTENTS_MENU = 0x0b,
        BT_AVRCP_OPID_FAVORITE_MENU = 0x0c,
        BT_AVRCP_OPID_EXIT = 0x0d,
 
        BT_AVRCP_OPID_0 = 0x20,
        BT_AVRCP_OPID_1 = 0x21,
        BT_AVRCP_OPID_2 = 0x22,
        BT_AVRCP_OPID_3 = 0x23,
        BT_AVRCP_OPID_4 = 0x24,
        BT_AVRCP_OPID_5 = 0x25,
        BT_AVRCP_OPID_6 = 0x26,
        BT_AVRCP_OPID_7 = 0x27,
        BT_AVRCP_OPID_8 = 0x28,
        BT_AVRCP_OPID_9 = 0x29,
        BT_AVRCP_OPID_DOT = 0x2a,
        BT_AVRCP_OPID_ENTER = 0x2b,
        BT_AVRCP_OPID_CLEAR = 0x2c,
 
        BT_AVRCP_OPID_CHANNEL_UP = 0x30,
        BT_AVRCP_OPID_CHANNEL_DOWN = 0x31,
        BT_AVRCP_OPID_PREVIOUS_CHANNEL = 0x32,
        BT_AVRCP_OPID_SOUND_SELECT = 0x33,
        BT_AVRCP_OPID_INPUT_SELECT = 0x34,
        BT_AVRCP_OPID_DISPLAY_INFORMATION = 0x35,
        BT_AVRCP_OPID_HELP = 0x36,
        BT_AVRCP_OPID_PAGE_UP = 0x37,
        BT_AVRCP_OPID_PAGE_DOWN = 0x38,
 
        BT_AVRCP_OPID_POWER = 0x40,
        BT_AVRCP_OPID_VOLUME_UP = 0x41,
        BT_AVRCP_OPID_VOLUME_DOWN = 0x42,
        BT_AVRCP_OPID_MUTE = 0x43,
        BT_AVRCP_OPID_PLAY = 0x44,
        BT_AVRCP_OPID_STOP = 0x45,
        BT_AVRCP_OPID_PAUSE = 0x46,
        BT_AVRCP_OPID_RECORD = 0x47,
        BT_AVRCP_OPID_REWIND = 0x48,
        BT_AVRCP_OPID_FAST_FORWARD = 0x49,
        BT_AVRCP_OPID_EJECT = 0x4a,
        BT_AVRCP_OPID_FORWARD = 0x4b,
        BT_AVRCP_OPID_BACKWARD = 0x4c,
 
        BT_AVRCP_OPID_ANGLE = 0x50,
        BT_AVRCP_OPID_SUBPICTURE = 0x51,
 
        BT_AVRCP_OPID_F1 = 0x71,
        BT_AVRCP_OPID_F2 = 0x72,
        BT_AVRCP_OPID_F3 = 0x73,
        BT_AVRCP_OPID_F4 = 0x74,
        BT_AVRCP_OPID_F5 = 0x75,
        BT_AVRCP_OPID_VENDOR_UNIQUE = 0x7e,
} bt_avrcp_opid_t;

typedef enum __packed {
        BT_AVRCP_BUTTON_PRESSED = 0,
        BT_AVRCP_BUTTON_RELEASED = 1,
} bt_avrcp_button_state_t;

typedef enum __packed {
        BT_AVRCP_STATUS_INVALID_COMMAND = 0x00,

        BT_AVRCP_STATUS_INVALID_PARAMETER = 0x01,

        BT_AVRCP_STATUS_PARAMETER_CONTENT_ERROR = 0x02,

        BT_AVRCP_STATUS_INTERNAL_ERROR = 0x03,

        BT_AVRCP_STATUS_OPERATION_COMPLETED = 0x04,

        BT_AVRCP_STATUS_UID_CHANGED = 0x05,

        BT_AVRCP_STATUS_INVALID_DIRECTION = 0x07,

        BT_AVRCP_STATUS_NOT_A_DIRECTORY = 0x08,

        BT_AVRCP_STATUS_DOES_NOT_EXIST = 0x09,

        BT_AVRCP_STATUS_INVALID_SCOPE = 0x0a,

        BT_AVRCP_STATUS_RANGE_OUT_OF_BOUNDS = 0x0b,

        BT_AVRCP_STATUS_FOLDER_ITEM_IS_NOT_PLAYABLE = 0x0c,

        BT_AVRCP_STATUS_MEDIA_IN_USE = 0x0d,

        BT_AVRCP_STATUS_NOW_PLAYING_LIST_FULL = 0x0e,

        BT_AVRCP_STATUS_SEARCH_NOT_SUPPORTED = 0x0f,

        BT_AVRCP_STATUS_SEARCH_IN_PROGRESS = 0x10,

        BT_AVRCP_STATUS_INVALID_PLAYER_ID = 0x11,

        BT_AVRCP_STATUS_PLAYER_NOT_BROWSABLE = 0x12,

        BT_AVRCP_STATUS_PLAYER_NOT_ADDRESSED = 0x13,

        BT_AVRCP_STATUS_NO_VALID_SEARCH_RESULTS = 0x14,

        BT_AVRCP_STATUS_NO_AVAILABLE_PLAYERS = 0x15,

        BT_AVRCP_STATUS_ADDRESSED_PLAYER_CHANGED = 0x16,
} bt_avrcp_status_t;

struct bt_avrcp_ct;
struct bt_avrcp_tg;
 
struct bt_avrcp_unit_info_rsp {
        bt_avrcp_subunit_type_t unit_type;
        uint32_t company_id;
};
 
struct bt_avrcp_subunit_info_rsp {
        bt_avrcp_subunit_type_t subunit_type;
        uint8_t max_subunit_id;
        const uint8_t *extended_subunit_type; 
        const uint8_t *extended_subunit_id;   
};
 
#define BT_AVRCP_PASSTHROUGH_GET_STATE(payload)                                                    \
        ((bt_avrcp_opid_t)(FIELD_GET(BIT(7), ((payload)->opid_state))))
#define BT_AVRCP_PASSTHROUGH_GET_OPID(payload)                                                     \
        ((bt_avrcp_button_state_t)(FIELD_GET(GENMASK(6, 0), ((payload)->opid_state))))
#define BT_AVRCP_PASSTHROUGH_SET_STATE_OPID(payload, state, opid)                                  \
        (payload)->opid_state = FIELD_PREP(BIT(7), state) | FIELD_PREP(GENMASK(6, 0), opid)
 
struct bt_avrcp_passthrough_opvu_data {
        uint8_t company_id[BT_AVRCP_COMPANY_ID_SIZE];
        uint16_t opid_vu;
} __packed;
 
struct bt_avrcp_passthrough_cmd {
        uint8_t opid_state; 
        uint8_t data_len;
        struct bt_avrcp_passthrough_opvu_data data[0]; 
} __packed;
 
struct bt_avrcp_passthrough_rsp {
        uint8_t opid_state; 
        uint8_t data_len;
        struct bt_avrcp_passthrough_opvu_data data[0]; 
} __packed;
 
struct bt_avrcp_get_cap_rsp {
        uint8_t cap_id;  
        uint8_t cap_cnt; 
        uint8_t cap[];   
} __packed;

typedef enum __packed {
        BT_AVRCP_CHARSET_UTF8 = 0x006a,
} bt_avrcp_charset_t;

struct bt_avrcp_folder_name {
        uint16_t folder_name_len;
        uint8_t folder_name[];
} __packed;

struct bt_avrcp_set_browsed_player_rsp {
        uint8_t status;                              
        uint16_t uid_counter;                        
        uint32_t num_items;                          
        uint16_t charset_id;                         
        uint8_t folder_depth;                        
        struct bt_avrcp_folder_name folder_names[0]; 
} __packed;
 
struct bt_avrcp_ct_cb {
        void (*connected)(struct bt_conn *conn, struct bt_avrcp_ct *ct);

        void (*disconnected)(struct bt_avrcp_ct *ct);

        void (*browsing_connected)(struct bt_conn *conn, struct bt_avrcp_ct *ct);

        void (*browsing_disconnected)(struct bt_avrcp_ct *ct);

        void (*get_cap_rsp)(struct bt_avrcp_ct *ct, uint8_t tid,
                            const struct bt_avrcp_get_cap_rsp *rsp);

        void (*unit_info_rsp)(struct bt_avrcp_ct *ct, uint8_t tid,
                              struct bt_avrcp_unit_info_rsp *rsp);

        void (*subunit_info_rsp)(struct bt_avrcp_ct *ct, uint8_t tid,
                                 struct bt_avrcp_subunit_info_rsp *rsp);

        void (*passthrough_rsp)(struct bt_avrcp_ct *ct, uint8_t tid, bt_avrcp_rsp_t result,
                                const struct bt_avrcp_passthrough_rsp *rsp);

        void (*browsed_player_rsp)(struct bt_avrcp_ct *ct, uint8_t tid, struct net_buf *buf);
};

int bt_avrcp_connect(struct bt_conn *conn);

int bt_avrcp_disconnect(struct bt_conn *conn);

struct net_buf *bt_avrcp_create_pdu(struct net_buf_pool *pool);

int bt_avrcp_browsing_connect(struct bt_conn *conn);

int bt_avrcp_browsing_disconnect(struct bt_conn *conn);

int bt_avrcp_ct_register_cb(const struct bt_avrcp_ct_cb *cb);

int bt_avrcp_ct_get_cap(struct bt_avrcp_ct *ct, uint8_t tid, uint8_t cap_id);

int bt_avrcp_ct_get_unit_info(struct bt_avrcp_ct *ct, uint8_t tid);

int bt_avrcp_ct_get_subunit_info(struct bt_avrcp_ct *ct, uint8_t tid);

int bt_avrcp_ct_passthrough(struct bt_avrcp_ct *ct, uint8_t tid, uint8_t opid, uint8_t state,
                            const uint8_t *payload, uint8_t len);

int bt_avrcp_ct_set_browsed_player(struct bt_avrcp_ct *ct, uint8_t tid, uint16_t player_id);
 
struct bt_avrcp_tg_cb {
        void (*connected)(struct bt_conn *conn, struct bt_avrcp_tg *tg);

        void (*disconnected)(struct bt_avrcp_tg *tg);

        void (*unit_info_req)(struct bt_avrcp_tg *tg, uint8_t tid);

        void (*subunit_info_req)(struct bt_avrcp_tg *tg, uint8_t tid);

        void (*browsing_connected)(struct bt_conn *conn, struct bt_avrcp_tg *tg);

        void (*browsing_disconnected)(struct bt_avrcp_tg *tg);

        void (*set_browsed_player_req)(struct bt_avrcp_tg *tg, uint8_t tid, uint16_t player_id);

        void (*passthrough_req)(struct bt_avrcp_tg *tg, uint8_t tid, struct net_buf *buf);
};

int bt_avrcp_tg_register_cb(const struct bt_avrcp_tg_cb *cb);

int bt_avrcp_tg_send_unit_info_rsp(struct bt_avrcp_tg *tg, uint8_t tid,
                                   struct bt_avrcp_unit_info_rsp *rsp);

int bt_avrcp_tg_send_subunit_info_rsp(struct bt_avrcp_tg *tg, uint8_t tid);

int bt_avrcp_tg_send_set_browsed_player_rsp(struct bt_avrcp_tg *tg, uint8_t tid,
                                            struct net_buf *buf);

int bt_avrcp_tg_send_passthrough_rsp(struct bt_avrcp_tg *tg, uint8_t tid, bt_avrcp_rsp_t result,
                                     struct net_buf *buf);
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AVRCP_H_ */