| /* |
| * Copyright (C) 2013 by Holger Hans Peter Freyther |
| * |
| * 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. |
| */ |
| |
| #pragma once |
| |
| #ifdef __cplusplus |
| |
| #include "gprs_rlcmac.h" |
| #include "llc.h" |
| #include "rlc.h" |
| #include <gprs_debug.h> |
| |
| #include <stdint.h> |
| |
| struct bssgp_bvc_ctx; |
| struct rlc_ul_header; |
| struct msgb; |
| |
| /* |
| * TBF instance |
| */ |
| |
| #define Tassign_agch 0,200000 /* waiting after IMM.ASS confirm */ |
| #define Tassign_pacch 2,0 /* timeout for pacch assigment */ |
| |
| enum gprs_rlcmac_tbf_state { |
| GPRS_RLCMAC_NULL = 0, /* new created TBF */ |
| GPRS_RLCMAC_ASSIGN, /* wait for downlink assignment */ |
| GPRS_RLCMAC_FLOW, /* RLC/MAC flow, resource needed */ |
| GPRS_RLCMAC_FINISHED, /* flow finished, wait for release */ |
| GPRS_RLCMAC_WAIT_RELEASE,/* wait for release or restart of DL TBF */ |
| GPRS_RLCMAC_RELEASING, /* releasing, wait to free TBI/USF */ |
| }; |
| |
| enum gprs_rlcmac_tbf_poll_state { |
| GPRS_RLCMAC_POLL_NONE = 0, |
| GPRS_RLCMAC_POLL_SCHED, /* a polling was scheduled */ |
| }; |
| |
| enum gprs_rlcmac_tbf_dl_ass_state { |
| GPRS_RLCMAC_DL_ASS_NONE = 0, |
| GPRS_RLCMAC_DL_ASS_SEND_ASS, /* send downlink assignment on next RTS */ |
| GPRS_RLCMAC_DL_ASS_WAIT_ACK, /* wait for PACKET CONTROL ACK */ |
| }; |
| |
| enum gprs_rlcmac_tbf_ul_ass_state { |
| GPRS_RLCMAC_UL_ASS_NONE = 0, |
| GPRS_RLCMAC_UL_ASS_SEND_ASS, /* send uplink assignment on next RTS */ |
| GPRS_RLCMAC_UL_ASS_WAIT_ACK, /* wait for PACKET CONTROL ACK */ |
| }; |
| |
| enum gprs_rlcmac_tbf_ul_ack_state { |
| GPRS_RLCMAC_UL_ACK_NONE = 0, |
| GPRS_RLCMAC_UL_ACK_SEND_ACK, /* send acknowledge on next RTS */ |
| GPRS_RLCMAC_UL_ACK_WAIT_ACK, /* wait for PACKET CONTROL ACK */ |
| }; |
| |
| enum gprs_rlcmac_tbf_direction { |
| GPRS_RLCMAC_DL_TBF, |
| GPRS_RLCMAC_UL_TBF |
| }; |
| |
| #define GPRS_RLCMAC_FLAG_CCCH 0 /* assignment on CCCH */ |
| #define GPRS_RLCMAC_FLAG_PACCH 1 /* assignment on PACCH */ |
| #define GPRS_RLCMAC_FLAG_UL_DATA 2 /* uplink data received */ |
| #define GPRS_RLCMAC_FLAG_DL_ACK 3 /* downlink acknowledge received */ |
| #define GPRS_RLCMAC_FLAG_TO_UL_ACK 4 |
| #define GPRS_RLCMAC_FLAG_TO_DL_ACK 5 |
| #define GPRS_RLCMAC_FLAG_TO_UL_ASS 6 |
| #define GPRS_RLCMAC_FLAG_TO_DL_ASS 7 |
| #define GPRS_RLCMAC_FLAG_TO_MASK 0xf0 /* timeout bits */ |
| |
| struct llist_pods { |
| struct llist_head list; |
| void *back; |
| }; |
| |
| #define llist_pods_entry(ptr, type) \ |
| ((type *)(container_of(ptr, struct llist_pods, list)->back)) |
| |
| /** |
| * llist_pods_for_each_entry - like llist_for_each_entry, but uses |
| * struct llist_pods ->back to access the entry. |
| * This is necessary for non-PODS classes because container_of is |
| * not guaranteed to work anymore. */ |
| #define llist_pods_for_each_entry(pos, head, member, lpods) \ |
| for (lpods = llist_entry((head)->next, typeof(struct llist_pods), list), \ |
| pos = ((typeof(pos))lpods->back), \ |
| prefetch(pos->member.list.next); \ |
| &lpods->list != (head); \ |
| lpods = llist_entry(lpods->list.next, typeof(struct llist_pods), list), \ |
| pos = ((typeof(pos))lpods->back),\ |
| prefetch(pos->member.list.next)) |
| |
| struct gprs_rlcmac_tbf { |
| |
| static void free_all(struct gprs_rlcmac_trx *trx); |
| static void free_all(struct gprs_rlcmac_pdch *pdch); |
| |
| bool state_is(enum gprs_rlcmac_tbf_state rhs) const; |
| bool state_is_not(enum gprs_rlcmac_tbf_state rhs) const; |
| void set_state(enum gprs_rlcmac_tbf_state new_state); |
| const char *state_name() const; |
| |
| struct msgb *create_dl_ass(uint32_t fn); |
| struct msgb *create_ul_ass(uint32_t fn); |
| |
| uint8_t tsc() const; |
| |
| int rlcmac_diag(); |
| |
| int update(); |
| void handle_timeout(); |
| void stop_timer(); |
| void stop_t3191(); |
| |
| void poll_timeout(); |
| |
| /** tlli handling */ |
| void update_tlli(uint32_t tlli); |
| uint32_t tlli() const; |
| bool is_tlli_valid() const; |
| void tlli_mark_valid(); |
| |
| uint8_t tfi() const; |
| |
| const char *imsi() const; |
| void assign_imsi(const char *imsi); |
| |
| void set_new_tbf(gprs_rlcmac_tbf *tbf); |
| gprs_rlcmac_tbf *new_tbf() const; |
| |
| time_t created_ts() const; |
| |
| /* attempt to make things a bit more fair */ |
| void rotate_in_list(); |
| |
| struct llist_pods list; |
| uint32_t state_flags; |
| enum gprs_rlcmac_tbf_direction direction; |
| struct gprs_rlcmac_trx *trx; |
| uint8_t first_ts; /* first TS used by TBF */ |
| uint8_t first_common_ts; /* first TS that the phone can send and |
| reveive simultaniously */ |
| uint8_t control_ts; /* timeslot control messages and polling */ |
| uint8_t ms_class; |
| struct gprs_rlcmac_pdch *pdch[8]; /* list of PDCHs allocated to TBF */ |
| uint16_t ta; |
| |
| gprs_llc m_llc; |
| |
| enum gprs_rlcmac_tbf_dl_ass_state dl_ass_state; |
| enum gprs_rlcmac_tbf_ul_ass_state ul_ass_state; |
| enum gprs_rlcmac_tbf_ul_ack_state ul_ack_state; |
| |
| gprs_rlcmac_tbf *m_new_tbf; |
| |
| enum gprs_rlcmac_tbf_poll_state poll_state; |
| uint32_t poll_fn; /* frame number to poll */ |
| |
| gprs_rlc m_rlc; |
| |
| uint8_t n3105; /* N3105 counter */ |
| |
| struct osmo_timer_list timer; |
| unsigned int T; /* Txxxx number */ |
| unsigned int num_T_exp; /* number of consecutive T expirations */ |
| |
| struct osmo_gsm_timer_list gsm_timer; |
| unsigned int fT; /* fTxxxx number */ |
| unsigned int num_fT_exp; /* number of consecutive fT expirations */ |
| |
| struct { |
| struct timeval rssi_tv; /* timestamp for rssi calculation */ |
| int32_t rssi_sum; /* sum of rssi values */ |
| int rssi_num; /* number of rssi values added since rssi_tv */ |
| } meas; |
| |
| uint8_t cs; /* current coding scheme */ |
| |
| /* these should become protected but only after gprs_rlcmac_data.c |
| * stops to iterate over all tbf in its current form */ |
| enum gprs_rlcmac_tbf_state state; |
| |
| /* Remember if the tbf was in wait_release state when we want to |
| * schedule a new dl assignment */ |
| uint8_t was_releasing; |
| |
| /* Can/should we upgrade this tbf to use multiple slots? */ |
| uint8_t upgrade_to_multislot; |
| |
| /* store the BTS this TBF belongs to */ |
| BTS *bts; |
| |
| /* |
| * private fields. We can't make it private as it is breaking the |
| * llist macros. |
| */ |
| uint32_t m_tlli; |
| uint8_t m_tlli_valid; |
| uint8_t m_tfi; |
| time_t m_created_ts; |
| |
| /* store IMSI for look-up and PCH retransmission */ |
| char m_imsi[16]; |
| |
| protected: |
| gprs_rlcmac_bts *bts_data() const; |
| |
| int extract_tlli(const uint8_t *data, const size_t len); |
| |
| static const char *tbf_state_name[6]; |
| }; |
| |
| |
| struct gprs_rlcmac_ul_tbf *tbf_alloc_ul(struct gprs_rlcmac_bts *bts, |
| int8_t use_trx, uint8_t ms_class, |
| uint32_t tlli, uint8_t ta, struct gprs_rlcmac_tbf *dl_tbf); |
| |
| struct gprs_rlcmac_ul_tbf *tbf_alloc_ul_tbf(struct gprs_rlcmac_bts *bts, |
| struct gprs_rlcmac_tbf *old_tbf, |
| uint8_t tfi, uint8_t trx, |
| uint8_t ms_class, uint8_t single_slot); |
| |
| struct gprs_rlcmac_dl_tbf *tbf_alloc_dl_tbf(struct gprs_rlcmac_bts *bts, |
| struct gprs_rlcmac_tbf *old_tbf, |
| uint8_t tfi, uint8_t trx, |
| uint8_t ms_class, uint8_t single_slot); |
| |
| void tbf_free(struct gprs_rlcmac_tbf *tbf); |
| |
| int tbf_assign_control_ts(struct gprs_rlcmac_tbf *tbf); |
| |
| void tbf_timer_start(struct gprs_rlcmac_tbf *tbf, unsigned int T, |
| unsigned int seconds, unsigned int microseconds); |
| |
| inline bool gprs_rlcmac_tbf::state_is(enum gprs_rlcmac_tbf_state rhs) const |
| { |
| return state == rhs; |
| } |
| |
| inline bool gprs_rlcmac_tbf::state_is_not(enum gprs_rlcmac_tbf_state rhs) const |
| { |
| return state != rhs; |
| } |
| |
| const char *tbf_name(gprs_rlcmac_tbf *tbf); |
| |
| inline const char *gprs_rlcmac_tbf::state_name() const |
| { |
| return tbf_state_name[state]; |
| } |
| |
| inline void gprs_rlcmac_tbf::set_state(enum gprs_rlcmac_tbf_state new_state) |
| { |
| LOGP(DRLCMAC, LOGL_DEBUG, "%s changes state from %s to %s\n", |
| tbf_name(this), |
| tbf_state_name[state], tbf_state_name[new_state]); |
| state = new_state; |
| } |
| |
| inline uint32_t gprs_rlcmac_tbf::tlli() const |
| { |
| return m_tlli; |
| } |
| |
| inline bool gprs_rlcmac_tbf::is_tlli_valid() const |
| { |
| return m_tlli_valid; |
| } |
| |
| inline uint8_t gprs_rlcmac_tbf::tfi() const |
| { |
| return m_tfi; |
| } |
| |
| inline const char *gprs_rlcmac_tbf::imsi() const |
| { |
| return m_imsi; |
| } |
| |
| inline gprs_rlcmac_tbf *gprs_rlcmac_tbf::new_tbf() const |
| { |
| return m_new_tbf; |
| } |
| |
| inline time_t gprs_rlcmac_tbf::created_ts() const |
| { |
| return m_created_ts; |
| } |
| |
| struct gprs_rlcmac_dl_tbf : public gprs_rlcmac_tbf { |
| /* dispatch Unitdata.DL messages */ |
| static int handle(struct gprs_rlcmac_bts *bts, |
| const uint32_t tlli, const char *imsi, const uint8_t ms_class, |
| const uint16_t delay_csec, const uint8_t *data, const uint16_t len); |
| |
| int append_data(const uint8_t ms_class, |
| const uint16_t pdu_delay_csec, |
| const uint8_t *data, const uint16_t len); |
| |
| int rcvd_dl_ack(uint8_t final, uint8_t ssn, uint8_t *rbb); |
| struct msgb *create_dl_acked_block(uint32_t fn, uint8_t ts); |
| |
| /* TODO: add the gettimeofday as parameter */ |
| struct msgb *llc_dequeue(bssgp_bvc_ctx *bctx); |
| |
| /* Please note that all variables here will be reset when changing |
| * from WAIT RELEASE back to FLOW state (re-use of TBF). |
| * All states that need reset must be in this struct, so this is why |
| * variables are in both (dl and ul) structs and not outside union. |
| */ |
| gprs_rlc_dl_window m_window; |
| int32_t m_tx_counter; /* count all transmitted blocks */ |
| uint8_t m_wait_confirm; /* wait for CCCH IMM.ASS cnf */ |
| |
| struct { |
| struct timeval dl_bw_tv; /* timestamp for dl bw calculation */ |
| uint32_t dl_bw_octets; /* number of octets since bw_tv */ |
| |
| struct timeval dl_loss_tv; /* timestamp for loss calculation */ |
| uint16_t dl_loss_lost; /* sum of lost packets */ |
| uint16_t dl_loss_received; /* sum of received packets */ |
| } m_bw; |
| |
| protected: |
| struct msgb *create_new_bsn(const uint32_t fn, const uint8_t ts); |
| struct msgb *create_dl_acked_block(const uint32_t fn, const uint8_t ts, |
| const int index, const bool fin_first_ack); |
| int update_window(const uint8_t ssn, const uint8_t *rbb); |
| int maybe_start_new_window(); |
| bool dl_window_stalled() const; |
| void reuse_tbf(const uint8_t *data, const uint16_t len); |
| }; |
| |
| struct gprs_rlcmac_ul_tbf : public gprs_rlcmac_tbf { |
| struct msgb *create_ul_ack(uint32_t fn); |
| |
| /* blocks were acked */ |
| int rcv_data_block_acknowledged(const uint8_t *data, size_t len, int8_t rssi); |
| |
| /* TODO: extract LLC class? */ |
| int assemble_forward_llc(const gprs_rlc_data *data); |
| int snd_ul_ud(); |
| |
| /* Please note that all variables here will be reset when changing |
| * from WAIT RELEASE back to FLOW state (re-use of TBF). |
| * All states that need reset must be in this struct, so this is why |
| * variables are in both (dl and ul) structs and not outside union. |
| */ |
| gprs_rlc_ul_window m_window; |
| int32_t m_rx_counter; /* count all received blocks */ |
| uint8_t m_n3103; /* N3103 counter */ |
| uint8_t m_usf[8]; /* list USFs per PDCH (timeslot) */ |
| uint8_t m_contention_resolution_done; /* set after done */ |
| uint8_t m_final_ack_sent; /* set if we sent final ack */ |
| |
| protected: |
| void maybe_schedule_uplink_acknack(const rlc_ul_header *rh); |
| }; |
| |
| #endif |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| #include <osmocom/vty/command.h> |
| #include <osmocom/vty/vty.h> |
| |
| |
| void tbf_print_vty_info(struct vty *vty, llist_head *tbf); |
| #ifdef __cplusplus |
| } |
| #endif |