swdp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 PHYTEC Messtechnik GmbH
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SWDP_H_
#define ZEPHYR_INCLUDE_SWDP_H_
 
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* SWDP packet request bits */
#define SWDP_REQUEST_APnDP                      BIT(0)
#define SWDP_REQUEST_RnW                        BIT(1)
#define SWDP_REQUEST_A2                         BIT(2)
#define SWDP_REQUEST_A3                         BIT(3)
 
/* SWDP acknowledge response bits */
#define SWDP_ACK_OK                             BIT(0)
#define SWDP_ACK_WAIT                           BIT(1)
#define SWDP_ACK_FAULT                          BIT(2)
 
/* SWDP transfer or parity error */
#define SWDP_TRANSFER_ERROR                     BIT(3)
 
/* SWDP Interface pins */
#define SWDP_SWCLK_PIN                  0U
#define SWDP_SWDIO_PIN                  1U
#define SWDP_nRESET_PIN                 7U
 
/*
 * Serial Wire Interface (SWDP) driver API.
 * This is the mandatory API any Serial Wire driver needs to expose.
 */
struct swdp_api {
        int (*swdp_output_sequence)(const struct device *dev,
                                    uint32_t count,
                                    const uint8_t *data);
 
        int (*swdp_input_sequence)(const struct device *dev,
                                   uint32_t count,
                                   uint8_t *data);
 
        int (*swdp_transfer)(const struct device *dev,
                             uint8_t request,
                             uint32_t *data,
                             uint8_t idle_cycles,
                             uint8_t *response);
 
        int (*swdp_set_pins)(const struct device *dev,
                             uint8_t pins, uint8_t value);
 
        int (*swdp_get_pins)(const struct device *dev, uint8_t *state);
 
        int (*swdp_set_clock)(const struct device *dev, uint32_t clock);
 
        int (*swdp_configure)(const struct device *dev,
                              uint8_t turnaround,
                              bool data_phase);
 
        int (*swdp_port_on)(const struct device *dev);
 
        int (*swdp_port_off)(const struct device *dev);
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SWDP_H_ */