|
1
|
#ifndef SSC_H_
|
|
2
|
#define SSC_H_
|
|
3
|
|
|
4
|
#include "board.h"
|
|
5
|
#include "ssc_buffer.h"
|
|
6
|
|
|
7
|
typedef enum {
|
|
8
|
METRIC_RX_OVERFLOWS, // No free buffer during Rx reload
|
|
9
|
METRIC_FREE_RX_BUFFERS, // Free Rx buffers, calculated on-the-fly
|
|
10
|
METRIC_MANAGEMENT_ERRORS, // One of the diverse types of management errors
|
|
11
|
METRIC_MANAGEMENT_ERRORS_1, // Internal buffer management error type 1
|
|
12
|
METRIC_MANAGEMENT_ERRORS_2, // Internal buffer management error type 2
|
|
13
|
METRIC_MANAGEMENT_ERRORS_3, // Internal buffer management error type 3
|
|
14
|
METRIC_LATE_TX_FRAMES, // Frames that only reached the SSC when TF already was high
|
|
15
|
METRIC_RX_FRAMES, // Frames received
|
|
16
|
METRIC_TX_FRAMES, // Frames sent
|
|
17
|
METRIC_TX_ABORTED_FRAMES, // Aborted send frames
|
|
18
|
_MAX_METRICS,
|
|
19
|
} ssc_metric;
|
|
20
|
|
|
21
|
extern int ssc_get_metric(ssc_metric metric, char **description, int *value);
|
|
22
|
|
|
23
|
typedef enum {
|
|
24
|
SSC_CALLBACK_RX_STARTING, // *data is ssh_handle_t *sh
|
|
25
|
SSC_CALLBACK_RX_STOPPED, // *data is ssh_handle_t *sh
|
|
26
|
SSC_CALLBACK_RX_FRAME_BEGIN, // *data is int *end_asserted
|
|
27
|
// may set *end_asserted = 1 to force tell the IRQ handler
|
|
28
|
// that you have detected the end of reception
|
|
29
|
SSC_CALLBACK_RX_FRAME_ENDED, // *data is ssc_dma_rx_buffer *buffer
|
|
30
|
SSC_CALLBACK_TX_FRAME_BEGIN,
|
|
31
|
SSC_CALLBACK_TX_FRAME_ENDED,
|
|
32
|
SSC_CALLBACK_TX_FRAME_ABORTED,
|
|
33
|
SSC_CALLBACK_SETUP, // *data is ssh_handle_t *sh
|
|
34
|
SSC_CALLBACK_TEARDOWN, // *data is ssh_handle_t *sh
|
|
35
|
} ssc_callback_reason;
|
|
36
|
typedef void (*ssc_callback_t)(ssc_callback_reason reason, void *data);
|
|
37
|
|
|
38
|
struct _ssc_handle;
|
|
39
|
|
|
40
|
typedef struct _ssc_handle ssc_handle_t;
|
|
41
|
|
|
42
|
extern void ssc_set_gate(int data_enabled);
|
|
43
|
|
|
44
|
extern void ssc_frame_started(void);
|
|
45
|
|
|
46
|
/* Rx/Tx initialization separate, since Tx disables PWM output ! */
|
|
47
|
extern ssc_handle_t* ssc_open(u_int8_t init_rx, u_int8_t init_tx, enum ssc_mode mode , ssc_callback_t callback);
|
|
48
|
|
|
49
|
extern int ssc_recv(ssc_handle_t* sh, ssc_dma_rx_buffer_t* *buffer, unsigned int timeout);
|
|
50
|
extern int ssc_send(ssc_handle_t* sh, ssc_dma_tx_buffer_t* buffer);
|
|
51
|
extern int ssc_send_abort(ssc_handle_t* sh);
|
|
52
|
|
|
53
|
extern void ssc_hard_reset(ssc_handle_t *sh);
|
|
54
|
|
|
55
|
extern int ssc_close(ssc_handle_t* sh);
|
|
56
|
|
|
57
|
extern void ssc_rx_stop_frame_ended(void);
|
|
58
|
|
|
59
|
#endif /*SSC_H_*/
|
