rtt/rtt.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/*
 * Copyright (C) 2016-2020 by Marc Schink <dev@zapb.de>
 */
 
#ifndef OPENOCD_RTT_RTT_H
#define OPENOCD_RTT_RTT_H
 
#include <stdint.h>
#include <stdbool.h>
 
#include <helper/command.h>
#include <target/target.h>
 
#define RTT_CB_MAX_ID_LENGTH    16
 
/* Control block size in bytes. */
#define RTT_CB_SIZE     (RTT_CB_MAX_ID_LENGTH + 2 * sizeof(uint32_t))
 
/* Channel structure size in bytes (32-bit architecture). */
#define RTT_CHANNEL_SIZE_32 24
 
/* Channel structure size in bytes (64-bit architecture). */
#define RTT_CHANNEL_SIZE_64 32
 
/* Minimal channel buffer size in bytes. */
#define RTT_CHANNEL_BUFFER_MIN_SIZE 2
 
struct rtt_control {
    target_addr_t address;
    char id[RTT_CB_MAX_ID_LENGTH];
    uint32_t num_up_channels;
    uint32_t num_down_channels;
};
 
struct rtt_channel {
    target_addr_t address;
    target_addr_t name_addr;
    target_addr_t buffer_addr;
    uint32_t size;
    uint32_t write_pos;
    uint32_t read_pos;
    uint32_t flags;
};
 
struct rtt_channel_info {
    char *name;
    size_t name_length;
    uint32_t size;
    uint32_t flags;
};
 
typedef int (*rtt_sink_read)(unsigned int channel, const uint8_t *buffer,
        size_t length, void *user_data);
 
struct rtt_sink_list {
    rtt_sink_read read;
    void *user_data;
 
    struct rtt_sink_list *next;
};
 
enum rtt_channel_type {
    RTT_CHANNEL_TYPE_UP,
    RTT_CHANNEL_TYPE_DOWN
};
 
struct rtt_source {
    int (*find_cb)(struct target *target,
        target_addr_t *address, size_t size, const char *id, bool *found,
        void *user_data);
    int (*read_cb)(struct target *target,
        target_addr_t address, struct rtt_control *ctrl_block,
        void *user_data);
    int (*read_channel_info)(struct target *target,
        const struct rtt_control *ctrl, unsigned int channel,
        enum rtt_channel_type type, struct rtt_channel_info *info,
        void *user_data);
    int (*start)(struct target *target,
        const struct rtt_control *ctrl, void *user_data);
    int (*stop)(struct target *target, void *user_data);
    int (*read)(struct target *target,
        const struct rtt_control *ctrl, struct rtt_sink_list **sinks,
        size_t num_channels, void *user_data);
    int (*write)(struct target *target,
        struct rtt_control *ctrl, unsigned int channel,
        const uint8_t *buffer, size_t *length, void *user_data);
};
 
int rtt_init(void);
 
int rtt_exit(void);
 
int rtt_register_source(const struct rtt_source source,
        struct target *target);
 
int rtt_setup(target_addr_t address, size_t size, const char *id);
 
int rtt_start(void);
 
int rtt_stop(void);
 
int rtt_get_polling_interval(unsigned int *interval);
 
int rtt_set_polling_interval(unsigned int interval);
 
bool rtt_configured(void);
 
bool rtt_found_cb(void);
 
const struct rtt_control *rtt_get_control(void);
 
int rtt_read_channel_info(unsigned int channel_index,
    enum rtt_channel_type type, struct rtt_channel_info *info);
 
int rtt_register_sink(unsigned int channel_index, rtt_sink_read read,
        void *user_data);
 
int rtt_unregister_sink(unsigned int channel_index, rtt_sink_read read,
        void *user_data);
 
int rtt_write_channel(unsigned int channel_index, const uint8_t *buffer,
        size_t *length);
 
extern const struct command_registration rtt_target_command_handlers[];
 
#endif /* OPENOCD_RTT_RTT_H */