summaryrefslogtreecommitdiffhomepage
path: root/digital/io/src/getsamples.h
blob: c033665d928768abcf51206f2b312ddfdce6da3a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#ifndef getsamples_h
#define getsamples_h
/* getsamples.h */
/*  {{{
 *
 * Copyright (C) 2008 Nélio Laranjeiro
 *
 * APBTeam:
 *        Web: http://apbteam.org/
 *      Email: team AT apbteam DOT org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * }}} */

/**
 * Get samples FSM associated data.
 */
struct getsamples_data_t
{
    /**
     * X position of the distributor where to get samples from.
     */
    uint32_t distributor_x;
    /**
     * Y position of the distributor where to get samples from.
     */
    uint32_t distributor_y;
    /**
     * Bit field to indicate where to put the sample.
     * If bit 0 is set to 1, a sample will be put into the out_right_box. If
     * set to 0, the out_right_box will not be used to store a sample.
     */
    uint8_t sample_bitfield;
    /**
     * Event to post to the top FSM when this one is finished.
     */
    uint8_t event;
};

/**
 * Get samples shared data.
 */
extern struct getsamples_data_t getsamples_data;

/**
 * Start the get samples FSM.
 * @param data get sample data initial configuration.
 */
void
getsamples_start (struct getsamples_data_t data);

/**
 * Configure the classifier (using the trap and the internal bit field) for
 * the first bit set to 1.
 * After the configuring the classifier, the bit will be reset to 0 to use the
 * next one when calling this function again.
 */
void
getsamples_configure_classifier (void);

#endif /* getsamples_h */